@aztec/aztec 0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2

package/dest/sandbox.js

@@ -0,0 +1,116 @@
+#!/usr/bin/env -S node --no-warnings
+import { AztecNodeService, getConfigEnvVars } from '@aztec/aztec-node';
+import { AnvilTestWatcher, EthCheatCodes, SignerlessWallet } from '@aztec/aztec.js';
+import { DefaultMultiCallEntrypoint } from '@aztec/aztec.js/entrypoint';
+import { createBlobSinkClient } from '@aztec/blob-sink/client';
+import { setupCanonicalL2FeeJuice } from '@aztec/cli/setup-contracts';
+import { NULL_KEY, createEthereumChain, deployL1Contracts, getL1ContractsConfigEnvVars, waitForPublicClient } from '@aztec/ethereum';
+import { createLogger } from '@aztec/foundation/log';
+import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vks';
+import { ProtocolContractAddress, protocolContractTreeRoot } from '@aztec/protocol-contracts';
+import { createPXEService, getPXEServiceConfig } from '@aztec/pxe';
+import { getConfigEnvVars as getTelemetryClientConfig, initTelemetryClient } from '@aztec/telemetry-client';
+import { createPublicClient, http as httpViemTransport } from 'viem';
+import { mnemonicToAccount } from 'viem/accounts';
+import { foundry } from 'viem/chains';
+import { DefaultMnemonic } from './mnemonic.js';
+const logger = createLogger('sandbox');
+const localAnvil = foundry;
+/**
+ * Function to deploy our L1 contracts to the sandbox L1
+ * @param aztecNodeConfig - The Aztec Node Config
+ * @param hdAccount - Account for publishing L1 contracts
+ */ export async function deployContractsToL1(aztecNodeConfig, hdAccount, contractDeployLogger = logger, opts = {}) {
+    const chain = aztecNodeConfig.l1RpcUrl ? createEthereumChain(aztecNodeConfig.l1RpcUrl, aztecNodeConfig.l1ChainId) : {
+        chainInfo: localAnvil
+    };
+    await waitForPublicClient(aztecNodeConfig);
+    const l1Contracts = await deployL1Contracts(aztecNodeConfig.l1RpcUrl, hdAccount, chain.chainInfo, contractDeployLogger, {
+        ...getL1ContractsConfigEnvVars(),
+        ...aztecNodeConfig,
+        l2FeeJuiceAddress: ProtocolContractAddress.FeeJuice,
+        vkTreeRoot: await getVKTreeRoot(),
+        protocolContractTreeRoot,
+        assumeProvenThrough: opts.assumeProvenThroughBlockNumber,
+        salt: opts.salt
+    });
+    aztecNodeConfig.l1Contracts = l1Contracts.l1ContractAddresses;
+    return aztecNodeConfig.l1Contracts;
+}
+/**
+ * Create and start a new Aztec Node and PXE. Deploys L1 contracts.
+ * Does not start any HTTP services nor populate any initial accounts.
+ * @param config - Optional Sandbox settings.
+ */ export async function createSandbox(config = {}) {
+    const aztecNodeConfig = {
+        ...getConfigEnvVars(),
+        ...config
+    };
+    const hdAccount = mnemonicToAccount(config.l1Mnemonic || DefaultMnemonic);
+    if (!aztecNodeConfig.publisherPrivateKey || aztecNodeConfig.publisherPrivateKey === NULL_KEY) {
+        const privKey = hdAccount.getHdKey().privateKey;
+        aztecNodeConfig.publisherPrivateKey = `0x${Buffer.from(privKey).toString('hex')}`;
+    }
+    if (!aztecNodeConfig.validatorPrivateKey || aztecNodeConfig.validatorPrivateKey === NULL_KEY) {
+        const privKey = hdAccount.getHdKey().privateKey;
+        aztecNodeConfig.validatorPrivateKey = `0x${Buffer.from(privKey).toString('hex')}`;
+    }
+    let watcher = undefined;
+    if (!aztecNodeConfig.p2pEnabled) {
+        const l1ContractAddresses = await deployContractsToL1(aztecNodeConfig, hdAccount, undefined, {
+            assumeProvenThroughBlockNumber: Number.MAX_SAFE_INTEGER,
+            salt: config.l1Salt ? parseInt(config.l1Salt) : undefined
+        });
+        const chain = aztecNodeConfig.l1RpcUrl ? createEthereumChain(aztecNodeConfig.l1RpcUrl, aztecNodeConfig.l1ChainId) : {
+            chainInfo: localAnvil
+        };
+        const publicClient = createPublicClient({
+            chain: chain.chainInfo,
+            transport: httpViemTransport(aztecNodeConfig.l1RpcUrl)
+        });
+        watcher = new AnvilTestWatcher(new EthCheatCodes(aztecNodeConfig.l1RpcUrl), l1ContractAddresses.rollupAddress, publicClient);
+        watcher.setIsSandbox(true);
+        await watcher.start();
+    }
+    const telemetry = initTelemetryClient(getTelemetryClientConfig());
+    // Create a local blob sink client inside the sandbox, no http connectivity
+    const blobSinkClient = createBlobSinkClient();
+    const node = await createAztecNode(aztecNodeConfig, {
+        telemetry,
+        blobSinkClient
+    });
+    const pxe = await createAztecPXE(node);
+    await setupCanonicalL2FeeJuice(new SignerlessWallet(pxe, new DefaultMultiCallEntrypoint(aztecNodeConfig.l1ChainId, aztecNodeConfig.version)), aztecNodeConfig.l1Contracts.feeJuicePortalAddress, undefined, logger.info);
+    const stop = async ()=>{
+        await node.stop();
+        await watcher?.stop();
+    };
+    return {
+        node,
+        pxe,
+        aztecNodeConfig,
+        stop
+    };
+}
+/**
+ * Create and start a new Aztec RPC HTTP Server
+ * @param config - Optional Aztec node settings.
+ */ export async function createAztecNode(config = {}, deps = {}) {
+    const aztecNodeConfig = {
+        ...getConfigEnvVars(),
+        ...config
+    };
+    const node = await AztecNodeService.createAndSync(aztecNodeConfig, deps);
+    return node;
+}
+/**
+ * Create and start a new Aztec PXE HTTP Server
+ * @param config - Optional PXE settings.
+ */ export async function createAztecPXE(node, config = {}) {
+    const pxeServiceConfig = {
+        ...getPXEServiceConfig(),
+        ...config
+    };
+    const pxe = await createPXEService(node, pxeServiceConfig);
+    return pxe;
+}

package/dest/splash.js

@@ -0,0 +1,2 @@
+export const splash = '\n' + '               _\n' + '    /\\        | |\n' + '   /  \\    ___| |_ ___  ___ \n' + '  / /\\ \\  |_  / __/ _ \\/ __|\n' + ' / ____ \\  / /| ||  __/ (__ \n' + '/_/___ \\_\\/___|\\__\\___|\\___|\n';
+export const github = 'https://github.com/AztecProtocol';

package/package.json

@@ -0,0 +1,119 @@
+{
+  "name": "@aztec/aztec",
+  "version": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+  "type": "module",
+  "exports": {
+    ".": "./dest/index.js"
+  },
+  "bin": "./dest/bin/index.js",
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts"
+    ],
+    "name": "Aztec Packages",
+    "tsconfig": "./tsconfig.json"
+  },
+  "scripts": {
+    "build": "yarn clean && tsc -b",
+    "start": "node --no-warnings ./dest/bin",
+    "start:debug": "node --inspect=0.0.0.0:9221 --no-warnings ./dest/bin",
+    "start:sandbox": "ETHEREUM_HOST=http://0.0.0.0:8545/ && yarn start start --sandbox",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T eslint --fix ./src && run -T prettier -w ./src",
+    "build:dev": "tsc -b --watch",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}",
+    "run:example:token": "LOG_LEVEL='verbose' node ./dest/examples/token.js"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "dependencies": {
+    "@aztec/accounts": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/archiver": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/aztec-faucet": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/aztec-node": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/aztec.js": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/bb-prover": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/blob-sink": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/bot": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/builder": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/circuit-types": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/circuits.js": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/cli": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/cli-wallet": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/entrypoints": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/ethereum": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/foundation": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/kv-store": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/noir-contracts.js": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/noir-protocol-circuits-types": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/p2p": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/p2p-bootstrap": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/proof-verifier": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/protocol-contracts": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/prover-client": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/prover-node": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/pxe": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/telemetry-client": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/txe": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@aztec/types": "0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2",
+    "@types/chalk": "^2.2.0",
+    "abitype": "^0.8.11",
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "koa": "^2.14.2",
+    "koa-router": "^12.0.0",
+    "viem": "2.22.8"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "types": "./dest/index.d.ts",
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.0",
+    "@types/koa": "^2.13.6",
+    "jest": "^29.5.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "jest": {
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src",
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
+        }
+      ]
+    },
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "reporters": [
+      "default"
+    ],
+    "testTimeout": 30000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/bin/index.ts

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+//
+import { injectCommands as injectBuilderCommands } from '@aztec/builder';
+import { injectCommands as injectWalletCommands } from '@aztec/cli-wallet';
+import { injectCommands as injectContractCommands } from '@aztec/cli/contracts';
+import { injectCommands as injectDevnetCommands } from '@aztec/cli/devnet';
+import { injectCommands as injectInfrastructureCommands } from '@aztec/cli/infrastructure';
+import { injectCommands as injectL1Commands } from '@aztec/cli/l1';
+import { injectCommands as injectMiscCommands } from '@aztec/cli/misc';
+import { injectCommands as injectPXECommands } from '@aztec/cli/pxe';
+import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
+import { fileURLToPath } from '@aztec/foundation/url';
+
+import { Command } from 'commander';
+import { readFileSync } from 'fs';
+import { dirname, resolve } from 'path';
+
+import { injectAztecCommands } from '../cli/index.js';
+
+const userLog = createConsoleLogger();
+const debugLogger = createLogger('cli');
+
+/** CLI & full node main entrypoint */
+async function main() {
+  const shutdown = () => {
+    process.exit(0);
+  };
+  process.once('SIGINT', shutdown);
+  process.once('SIGTERM', shutdown);
+
+  const packageJsonPath = resolve(dirname(fileURLToPath(import.meta.url)), '../../package.json');
+  const cliVersion: string = JSON.parse(readFileSync(packageJsonPath).toString()).version;
+  let program = new Command('aztec');
+  program.description('Aztec command line interface').version(cliVersion);
+  program = injectAztecCommands(program, userLog, debugLogger);
+  program = injectBuilderCommands(program);
+  program = injectContractCommands(program, userLog, debugLogger);
+  program = injectInfrastructureCommands(program, userLog, debugLogger);
+  program = injectL1Commands(program, userLog, debugLogger);
+  program = injectPXECommands(program, userLog, debugLogger);
+  program = injectMiscCommands(program, userLog);
+  program = injectDevnetCommands(program, userLog, debugLogger);
+  program = injectWalletCommands(program, userLog, debugLogger);
+
+  await program.parseAsync(process.argv);
+}
+
+main().catch(err => {
+  debugLogger.error(`Error in command execution`);
+  debugLogger.error(err + '\n' + err.stack);
+  // See https://nodejs.org/api/process.html#processexitcode
+  process.exitCode = 1;
+  throw err;
+});

package/src/cli/aztec_start_action.ts

@@ -0,0 +1,115 @@
+import { deployInitialTestAccounts } from '@aztec/accounts/testing';
+import { AztecNodeApiSchema, PXESchema } from '@aztec/circuit-types';
+import {
+  type NamespacedApiHandlers,
+  createNamespacedSafeJsonRpcServer,
+  startHttpRpcServer,
+} from '@aztec/foundation/json-rpc/server';
+import { type LogFn, type Logger } from '@aztec/foundation/log';
+import { fileURLToPath } from '@aztec/foundation/url';
+import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
+
+import { readFileSync } from 'fs';
+import { dirname, resolve } from 'path';
+
+import { createSandbox } from '../sandbox.js';
+import { github, splash } from '../splash.js';
+import { createAccountLogs, extractNamespacedOptions, installSignalHandlers } from './util.js';
+
+const packageJsonPath = resolve(dirname(fileURLToPath(import.meta.url)), '../../package.json');
+const cliVersion: string = JSON.parse(readFileSync(packageJsonPath).toString()).version;
+
+export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logger) {
+  // list of 'stop' functions to call when process ends
+  const signalHandlers: Array<() => Promise<void>> = [];
+  const services: NamespacedApiHandlers = {};
+
+  if (options.sandbox) {
+    const sandboxOptions = extractNamespacedOptions(options, 'sandbox');
+    const nodeOptions = extractNamespacedOptions(options, 'node');
+    userLog(`${splash}\n${github}\n\n`);
+    userLog(`Setting up Aztec Sandbox ${cliVersion}, please stand by...`);
+
+    const { aztecNodeConfig, node, pxe, stop } = await createSandbox({
+      l1Mnemonic: options.l1Mnemonic,
+      l1RpcUrl: options.l1RpcUrl,
+      l1Salt: nodeOptions.deployAztecContractsSalt,
+    });
+
+    // Deploy test accounts by default
+    if (sandboxOptions.testAccounts) {
+      if (aztecNodeConfig.p2pEnabled) {
+        userLog(`Not setting up test accounts as we are connecting to a network`);
+      } else if (sandboxOptions.noPXE) {
+        userLog(`Not setting up test accounts as we are not exposing a PXE`);
+      } else {
+        userLog('Setting up test accounts...');
+        const accounts = await deployInitialTestAccounts(pxe);
+        const accLogs = await createAccountLogs(accounts, pxe);
+        userLog(accLogs.join(''));
+      }
+    }
+
+    // Start Node and PXE JSON-RPC server
+    signalHandlers.push(stop);
+    services.node = [node, AztecNodeApiSchema];
+    if (!sandboxOptions.noPXE) {
+      services.pxe = [pxe, PXESchema];
+    } else {
+      userLog(`Not exposing PXE API through JSON-RPC server`);
+    }
+  } else {
+    if (options.node) {
+      const { startNode } = await import('./cmds/start_node.js');
+      await startNode(options, signalHandlers, services, userLog);
+    } else if (options.proofVerifier) {
+      const { startProofVerifier } = await import('./cmds/start_proof_verifier.js');
+      await startProofVerifier(options, signalHandlers, userLog);
+    } else if (options.bot) {
+      const { startBot } = await import('./cmds/start_bot.js');
+      await startBot(options, signalHandlers, services, userLog);
+    } else if (options.proverNode) {
+      const { startProverNode } = await import('./cmds/start_prover_node.js');
+      await startProverNode(options, signalHandlers, services, userLog);
+    } else if (options.pxe) {
+      const { startPXE } = await import('./cmds/start_pxe.js');
+      await startPXE(options, signalHandlers, services, userLog);
+    } else if (options.archiver) {
+      const { startArchiver } = await import('./cmds/start_archiver.js');
+      await startArchiver(options, signalHandlers, services);
+    } else if (options.p2pBootstrap) {
+      const { startP2PBootstrap } = await import('./cmds/start_p2p_bootstrap.js');
+      await startP2PBootstrap(options, signalHandlers, services, userLog);
+    } else if (options.proverAgent) {
+      const { startProverAgent } = await import('./cmds/start_prover_agent.js');
+      await startProverAgent(options, signalHandlers, services, userLog);
+    } else if (options.proverBroker) {
+      const { startProverBroker } = await import('./cmds/start_prover_broker.js');
+      await startProverBroker(options, signalHandlers, services, userLog);
+    } else if (options.txe) {
+      const { startTXE } = await import('./cmds/start_txe.js');
+      await startTXE(options, debugLogger);
+    } else if (options.sequencer) {
+      userLog(`Cannot run a standalone sequencer without a node`);
+      process.exit(1);
+    } else if (options.faucet) {
+      const { startFaucet } = await import('./cmds/start_faucet.js');
+      await startFaucet(options, signalHandlers, services, userLog);
+    } else {
+      userLog(`No module specified to start`);
+      process.exit(1);
+    }
+  }
+
+  installSignalHandlers(debugLogger.info, signalHandlers);
+
+  if (Object.entries(services).length > 0) {
+    const rpcServer = createNamespacedSafeJsonRpcServer(services, {
+      http200OnError: false,
+      log: debugLogger,
+      middlewares: [getOtelJsonRpcPropagationMiddleware()],
+    });
+    const { port } = await startHttpRpcServer(rpcServer, { port: options.port });
+    debugLogger.info(`Aztec Server listening on port ${port}`);
+  }
+}