@aztec/aztec 0.0.1-commit.2b2662070 → 0.0.1-commit.2c0ee1788

package/scripts/add_crate.sh

@@ -2,10 +2,11 @@
 set -euo pipefail
 
 # Creates a contract+test crate pair and adds them to an existing workspace.
-# Usage: add_crate.sh <crate_name>
+# Usage: add_crate.sh <crate_name> <template>
 # Must be called from a workspace root that already has Nargo.toml with [workspace].
 
 crate_name=$1
+template=$2
 
 if [ -z "$crate_name" ]; then
   echo "Error: crate name is required"
@@ -31,64 +32,13 @@ fi
 
 # Get the actual aztec version for the git tag.
 AZTEC_VERSION=$(jq -r '.version' $(dirname $0)/../package.json)
+TEMPLATE_DIR="$(dirname $0)/templates/$template"
 
-# 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"
+# Copy template crates and substitute placeholders
+cp -r "$TEMPLATE_DIR/contract" "$contract_dir"
+cp -r "$TEMPLATE_DIR/test" "$test_dir"
+find "$contract_dir" "$test_dir" -type f -exec \
+  sed -i -e "s/__CRATE_NAME__/${crate_name}/g" -e "s/__AZTEC_VERSION__/${AZTEC_VERSION}/g" {} +
 
 # Add members to workspace Nargo.toml
 if grep -q 'members\s*=\s*\[\s*\]' Nargo.toml; then

package/scripts/aztec.sh

@@ -23,10 +23,14 @@ case $cmd in
     # 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"}"
+    export LOG_LEVEL="${LOG_LEVEL:-"error;trace:^contract:"}"
     aztec start --txe --port 8081 &
     server_pid=$!
     trap 'kill $server_pid &>/dev/null || true' EXIT
+    if ! command -v nc &>/dev/null; then
+      echo "Error: 'nc' (netcat) is required but not installed." >&2
+      exit 1
+    fi
     while ! nc -z 127.0.0.1 8081 &>/dev/null; do sleep 0.2; done
     export NARGO_FOREIGN_CALL_TIMEOUT=300000
     nargo test --silence-warnings --oracle-resolver http://127.0.0.1:8081 --test-threads 16 "$@"

package/scripts/init.sh

@@ -16,11 +16,11 @@ Options:
   -h, --help     Print help
 
 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.
+a workspace containing a Counter contract example with tests. The Counter
+demonstrates private state, private functions, and utility reads.
 
-If a workspace already exists in the current directory, use
-'aztec new <name>' instead to add another contract.
+Use 'aztec new <name>' to create a blank contract project, or to add another
+contract to an existing workspace.
 EOF
       exit 0
       ;;
@@ -36,4 +36,4 @@ done
 package_name="$(basename $(pwd))"
 
 echo "Initializing Aztec contract project..."
-$script_path/setup_workspace.sh "$package_name"
+$script_path/setup_workspace.sh "$package_name" counter

package/scripts/new.sh

@@ -68,7 +68,7 @@ fi
 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"
+  $script_path/add_crate.sh "$package_name" blank
 else
   # Create new workspace
   if [ -d "$project_path" ] && [ "$(ls -A $project_path 2>/dev/null)" ]; then
@@ -79,5 +79,5 @@ else
   echo "Creating new Aztec contract project at $project_path..."
   mkdir -p "$project_path"
   cd "$project_path"
-  $script_path/setup_workspace.sh "$package_name"
+  $script_path/setup_workspace.sh "$package_name" blank
 fi

package/scripts/setup_workspace.sh

@@ -2,10 +2,11 @@
 set -euo pipefail
 
 # Creates an Aztec contract workspace with a contract crate and a test crate.
-# Usage: setup_workspace.sh <package_name>
+# Usage: setup_workspace.sh <package_name> <template>
 # Must be called from the workspace root directory.
 
 package_name=$1
+template=$2
 script_path=$(realpath $(dirname "$0"))
 
 if [ -z "$package_name" ]; then
@@ -26,7 +27,7 @@ members = []
 EOF
 
 # Create the first crate pair
-$script_path/add_crate.sh "$package_name"
+$script_path/add_crate.sh "$package_name" "$template"
 
 # Create README
 cat > README.md << REOF

package/scripts/templates/blank/contract/Nargo.toml

@@ -0,0 +1,6 @@
+[package]
+name = "__CRATE_NAME___contract"
+type = "contract"
+
+[dependencies]
+aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }

package/scripts/templates/blank/contract/src/main.nr

@@ -0,0 +1,10 @@
+use aztec::macros::aztec;
+
+#[aztec]
+pub contract Main {
+    use aztec::macros::functions::{external, initializer};
+
+    #[initializer]
+    #[external("private")]
+    fn constructor() {}
+}

package/scripts/templates/blank/test/Nargo.toml

@@ -0,0 +1,7 @@
+[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 = "../__CRATE_NAME___contract" }

package/scripts/templates/blank/test/src/lib.nr

@@ -0,0 +1,11 @@
+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();
+
+    let _contract_address = env.deploy("@__CRATE_NAME___contract/Main")
+        .with_private_initializer(deployer, Main::interface().constructor());
+}

package/scripts/templates/counter/contract/Nargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "__CRATE_NAME___contract"
+type = "contract"
+
+[dependencies]
+aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }
+balance_set = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="balance-set" }

package/scripts/templates/counter/contract/src/main.nr

@@ -0,0 +1,48 @@
+use aztec::macros::aztec;
+
+#[aztec]
+pub contract Counter {
+    use aztec::{
+        macros::{functions::{external, initializer}, storage::storage},
+        messages::message_delivery::MessageDelivery,
+        protocol::address::AztecAddress,
+        state_vars::Owned,
+    };
+    use balance_set::BalanceSet;
+
+    #[storage]
+    struct Storage<Context> {
+        // Each owner has their own counter, stored as private encrypted notes.
+        // Owned: dictates who will receive the encrypted notes.
+        // BalanceSet: manages the underlying notes, providing add/sub/balance_of.
+        counters: Owned<BalanceSet<Context>, Context>,
+    }
+
+    // Sets the owner's counter to an initial value.
+    //
+    // #[external("private")]: executes on the user's device, inputs are hidden from everyone.
+    #[initializer]
+    #[external("private")]
+    fn constructor(initial_value: u128, owner: AztecAddress) {
+        // Delivers the note to the recipient onchain with provable correctness.
+        // Without delivery, the recipient can't find or decrypt the note.
+        self.storage.counters.at(owner).add(initial_value).deliver(
+            MessageDelivery.ONCHAIN_CONSTRAINED,
+        );
+    }
+
+    // Adds 1 to the owner's counter.
+    #[external("private")]
+    fn increment(owner: AztecAddress) {
+        self.storage.counters.at(owner).add(1).deliver(MessageDelivery.ONCHAIN_CONSTRAINED);
+    }
+
+    // Returns the current value of the owner's counter.
+    //
+    // #[external("utility")]: runs off-chain, no transaction created, no cost.
+    // Only the owner can decrypt and read their own counter.
+    #[external("utility")]
+    unconstrained fn get_counter(owner: AztecAddress) -> u128 {
+        self.storage.counters.at(owner).balance_of()
+    }
+}

package/scripts/templates/counter/test/Nargo.toml

@@ -0,0 +1,7 @@
+[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 = "../__CRATE_NAME___contract" }

package/scripts/templates/counter/test/src/lib.nr

@@ -0,0 +1,32 @@
+use aztec::{protocol::address::AztecAddress, test::helpers::test_environment::TestEnvironment};
+use __CRATE_NAME___contract::Counter;
+
+unconstrained fn setup(initial_value: u128) -> (TestEnvironment, AztecAddress, AztecAddress) {
+    let mut env = TestEnvironment::new();
+    let owner = env.create_light_account();
+
+    let contract_address = env.deploy("@__CRATE_NAME___contract/Counter")
+        .with_private_initializer(owner, Counter::interface().constructor(initial_value, owner));
+
+    (env, contract_address, owner)
+}
+
+#[test]
+unconstrained fn test_constructor() {
+    let initial_value = 5;
+    let (env, contract_address, owner) = setup(initial_value);
+
+    let counter = env.execute_utility(Counter::at(contract_address).get_counter(owner));
+    assert_eq(counter, initial_value);
+}
+
+#[test]
+unconstrained fn test_increment() {
+    let initial_value = 5;
+    let (mut env, contract_address, owner) = setup(initial_value);
+
+    env.call_private(owner, Counter::at(contract_address).increment(owner));
+
+    let counter = env.execute_utility(Counter::at(contract_address).get_counter(owner));
+    assert_eq(counter, initial_value + 1);
+}

package/src/cli/aztec_start_action.ts

@@ -27,8 +27,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
   let config: ChainConfig | undefined = undefined;
 
   if (options.localNetwork) {
-    const localNetwork = extractNamespacedOptions(options, 'local-network');
-    localNetwork.testAccounts = true;
+    const localNetwork = extractNamespacedOptions(options, 'localNetwork');
     userLog(`${splash}\n${github}\n\n`);
     userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
 
@@ -82,7 +81,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
       await startProverBroker(options, signalHandlers, services, userLog);
     } else if (options.txe) {
       const { startTXE } = await import('./cmds/start_txe.js');
-      await startTXE(options, debugLogger);
+      await startTXE(options, signalHandlers, debugLogger);
     } else if (options.sequencer) {
       userLog(`Cannot run a standalone sequencer without a node`);
       process.exit(1);

package/src/cli/aztec_start_options.ts

@@ -129,6 +129,12 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
       defaultValue: DefaultMnemonic,
       env: 'MNEMONIC',
     },
+    {
+      flag: '--local-network.testAccounts',
+      description: 'Deploy test accounts on local network start',
+      env: 'TEST_ACCOUNTS',
+      ...booleanConfigHelper(true),
+    },
   ],
   API: [
     {
@@ -320,15 +326,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
     },
     ...getOptions('bot', botConfigMappings),
   ],
-  PXE: [
-    {
-      flag: '--pxe',
-      description: 'Starts Aztec PXE with options',
-      defaultValue: undefined,
-      env: undefined,
-    },
-    ...getOptions('pxe', allPxeConfigMappings),
-  ],
+  PXE: [...getOptions('pxe', allPxeConfigMappings)],
   TXE: [
     {
       flag: '--txe',

package/src/cli/cmds/compile.ts

@@ -3,7 +3,7 @@ import type { LogFn } from '@aztec/foundation/log';
 
 import { execFileSync } from 'child_process';
 import type { Command } from 'commander';
-import { readFile, writeFile } from 'fs/promises';
+import { readFile } from 'fs/promises';
 import { join } from 'path';
 
 import { readArtifactFiles } from './utils/artifacts.js';
@@ -25,19 +25,6 @@ async function collectContractArtifacts(): Promise<string[]> {
   return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
 }
 
-/** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
-async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
-  for (const path of artifactPaths) {
-    const artifact = JSON.parse(await readFile(path, 'utf-8'));
-    for (const fn of artifact.functions) {
-      if (typeof fn.name === 'string') {
-        fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
-      }
-    }
-    await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
-  }
-}
-
 /** 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>();
@@ -161,9 +148,6 @@ async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<vo
     log('Postprocessing contracts...');
     const bbArgs = artifacts.flatMap(a => ['-i', a]);
     await run(bb, ['aztec_process', ...bbArgs]);
-
-    // TODO: This should be part of bb aztec_process!
-    await stripInternalPrefixes(artifacts);
   }
 
   log('Compilation complete!');

package/src/cli/cmds/profile.ts

@@ -11,8 +11,9 @@ export function injectProfileCommand(program: Command, log: LogFn): Command {
   profile
     .command('gates')
     .argument('[target-dir]', 'Path to the compiled artifacts directory', './target')
+    .option('--json', 'Output gate counts as JSON instead of a table', false)
     .description('Display gate counts for all compiled Aztec artifacts in a target directory.')
-    .action((targetDir: string) => profileGates(targetDir, log));
+    .action((targetDir: string, options: { json: boolean }) => profileGates(targetDir, options.json, log));
 
   profile
     .command('flamegraph')

package/src/cli/cmds/profile_gates.ts

@@ -6,12 +6,13 @@ import { execFile as execFileCb } from 'child_process';
 import { rm } from 'fs/promises';
 import { promisify } from 'util';
 
-import { MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
+import { type DiscoveredArtifact, MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
 
 const execFile = promisify(execFileCb);
 
 interface GateCountResult {
   name: string;
+  type: DiscoveredArtifact['type'];
   gateCount: number;
 }
 
@@ -32,24 +33,39 @@ 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> {
+export async function profileGates(targetDir: string, json: boolean, log: LogFn): Promise<void> {
   const bb = process.env.BB ?? findBbBinary() ?? 'bb';
   const { artifacts, tmpDir } = await discoverArtifacts(targetDir);
 
   if (artifacts.length === 0) {
-    log('No artifacts found in target directory.');
+    if (json) {
+      log('[]');
+    } else {
+      log('No artifacts found in target directory.');
+    }
     return;
   }
 
   try {
     const results: GateCountResult[] = await asyncPool(MAX_CONCURRENT, artifacts, async artifact => ({
       name: artifact.name,
+      type: artifact.type,
       gateCount: await getGateCount(bb, artifact.filePath),
     }));
     results.sort((a, b) => a.name.localeCompare(b.name));
 
     if (results.length === 0) {
-      log('No constrained circuits found.');
+      if (json) {
+        log('[]');
+      } else {
+        log('No constrained circuits found.');
+      }
+      return;
+    }
+
+    if (json) {
+      const entries = results.map(r => ({ name: r.name, type: r.type, gates: r.gateCount }));
+      log(JSON.stringify(entries, null, 2));
       return;
     }
 

package/src/cli/cmds/start_prover_agent.ts

@@ -24,8 +24,8 @@ export async function startProverAgent(
   services: NamespacedApiHandlers,
   userLog: LogFn,
 ) {
-  if (options.node || options.sequencer || options.pxe || options.p2pBootstrap || options.txe) {
-    userLog(`Starting a prover agent with --node, --sequencer, --pxe, --p2p-bootstrap, or --txe is not supported.`);
+  if (options.node || options.sequencer || options.p2pBootstrap || options.txe) {
+    userLog(`Starting a prover agent with --node, --sequencer, --p2p-bootstrap, or --txe is not supported.`);
     process.exit(1);
   }
 

package/src/cli/cmds/start_prover_broker.ts

@@ -24,8 +24,8 @@ export async function startProverBroker(
   services: NamespacedApiHandlers,
   userLog: LogFn,
 ): Promise<{ broker: ProvingJobBroker; config: ProverBrokerConfig }> {
-  if (options.node || options.sequencer || options.pxe || options.p2pBootstrap || options.txe) {
-    userLog(`Starting a prover broker with --node, --sequencer, --pxe, --p2p-bootstrap, or --txe is not supported.`);
+  if (options.node || options.sequencer || options.p2pBootstrap || options.txe) {
+    userLog(`Starting a prover broker with --node, --sequencer, --p2p-bootstrap, or --txe is not supported.`);
     process.exit(1);
   }
 

package/src/cli/cmds/start_txe.ts

@@ -2,14 +2,16 @@ import { startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
 import type { Logger } from '@aztec/foundation/log';
 import { createTXERpcServer } from '@aztec/txe';
 
-export async function startTXE(options: any, debugLogger: Logger) {
+export async function startTXE(options: any, signalHandlers: Array<() => Promise<void>>, debugLogger: Logger) {
   debugLogger.info(`Setting up TXE...`);
 
   const txeServer = createTXERpcServer(debugLogger);
-  const { port } = await startHttpRpcServer(txeServer, {
+  const httpServer = await startHttpRpcServer(txeServer, {
     port: options.port,
     timeoutMs: 1e3 * 60 * 5,
   });
 
-  debugLogger.info(`TXE listening on port ${port}`);
+  signalHandlers.push(() => new Promise<void>(resolve => httpServer.close(() => resolve())));
+
+  debugLogger.info(`TXE listening on port ${httpServer.port}`);
 }

package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts

@@ -7,7 +7,25 @@ import { join } from 'path';
 
 import { collectCrateDirs } from './collect_crate_dirs.js';
 
-/** Warns if the `aztec` dependency tag in any crate's Nargo.toml doesn't match the CLI version. */
+/** Returns true if the given git URL points to the AztecProtocol/aztec-nr repository. */
+function isAztecNrGitUrl(gitUrl: string): boolean {
+  let url: URL;
+  try {
+    url = new URL(gitUrl);
+  } catch {
+    return false;
+  }
+  if (url.hostname !== 'github.com') {
+    return false;
+  }
+  const repoPath = url.pathname
+    .replace(/^\//, '')
+    .replace(/\.git$/, '')
+    .replace(/\/$/, '');
+  return repoPath === 'AztecProtocol/aztec-nr';
+}
+
+/** Warns if any aztec-nr git dependency in a crate's Nargo.toml has a tag that doesn't match the CLI version. */
 export async function warnIfAztecVersionMismatch(log: LogFn, cliVersion?: string): Promise<void> {
   const version = cliVersion ?? getPackageVersion();
   if (!version) {
@@ -16,7 +34,7 @@ export async function warnIfAztecVersionMismatch(log: LogFn, cliVersion?: string
   }
 
   const expectedTag = `v${version}`;
-  const mismatches: { file: string; tag: string }[] = [];
+  const mismatches: { file: string; depName: string; tag: string }[] = [];
 
   const crateDirs = await collectCrateDirs('.', { skipGitDeps: true });
 
@@ -30,23 +48,28 @@ export async function warnIfAztecVersionMismatch(log: LogFn, cliVersion?: string
     }
 
     const parsed = TOML.parse(content) as Record<string, any>;
-    const aztecDep = (parsed.dependencies as Record<string, any>)?.aztec;
-    if (!aztecDep || typeof aztecDep !== 'object' || typeof aztecDep.tag !== 'string') {
-      // If a dep called "aztec" doesn't exist or it does not get parsed to an object or it doesn't have a tag defined
-      // we skip the check.
-      continue;
-    }
+    const deps = (parsed.dependencies as Record<string, any>) ?? {};
 
-    if (aztecDep.tag !== expectedTag) {
-      mismatches.push({ file: tomlPath, tag: aztecDep.tag });
+    for (const [depName, dep] of Object.entries(deps)) {
+      // Skip non-object deps (e.g. malformed entries) and anything that isn't a tagged git dep.
+      if (!dep || typeof dep !== 'object' || typeof dep.git !== 'string' || typeof dep.tag !== 'string') {
+        continue;
+      }
+      // Only flag deps that are sourced from the aztec-nr repo.
+      if (!isAztecNrGitUrl(dep.git)) {
+        continue;
+      }
+      if (dep.tag !== expectedTag) {
+        mismatches.push({ file: tomlPath, depName, tag: dep.tag });
+      }
     }
   }
 
   if (mismatches.length > 0) {
-    const details = mismatches.map(m => `  ${m.file} (${m.tag})`).join('\n');
+    const details = mismatches.map(m => `  ${m.file} — ${m.depName} (${m.tag})`).join('\n');
     log(
       `WARNING: Aztec dependency version mismatch detected.\n` +
-        `The following crates have an aztec dependency that does not match the CLI version (${expectedTag}):\n` +
+        `The following aztec-nr dependencies do not match the CLI version (${expectedTag}):\n` +
         `${details}\n\n` +
         `See https://docs.aztec.network/errors/9 for how to update your dependencies.`,
     );