@aztec/aztec 0.0.0-test.1 → 0.0.1-commit.017a351

package/src/cli/aztec_start_options.ts

@@ -1,8 +1,10 @@
 import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
-import { faucetConfigMapping } from '@aztec/aztec-faucet/config';
-import { sequencerClientConfigMappings } from '@aztec/aztec-node/config';
-import { blobSinkConfigMappings } from '@aztec/blob-sink/server';
+import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
 import { botConfigMappings } from '@aztec/bot/config';
+import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
+import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
+import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
+import { getKeys } from '@aztec/foundation/collection';
 import {
   type ConfigMapping,
   type EnvVar,
@@ -10,16 +12,16 @@ import {
   isBooleanConfigValue,
   omitConfigMappings,
 } from '@aztec/foundation/config';
+import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
 import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
-import {
-  type ProverAgentConfig,
-  type ProverBrokerConfig,
-  proverAgentConfigMappings,
-  proverBrokerConfigMappings,
-} from '@aztec/prover-client/broker';
+import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
 import { proverNodeConfigMappings } from '@aztec/prover-node/config';
 import { allPxeConfigMappings } from '@aztec/pxe/config';
-import { telemetryClientConfigMappings } from '@aztec/telemetry-client';
+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';
 
 import { DefaultMnemonic } from '../mnemonic.js';
 
@@ -27,15 +29,18 @@ import { DefaultMnemonic } from '../mnemonic.js';
 export interface AztecStartOption {
   flag: string;
   description: string;
-  defaultValue: any | undefined;
+  defaultValue: any;
   printDefault?: (val: any) => string;
-  envVar: EnvVar | undefined;
+  env: EnvVar | undefined;
+  fallback?: EnvVar[];
   parseVal?: (val: string) => any;
 }
 
-export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping>) => {
+export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => {
   const options: AztecStartOption[] = [];
-  for (const [key, { env, defaultValue: def, parseEnv, description, printDefault }] of Object.entries(configMappings)) {
+  for (const [key, { env, defaultValue: def, parseEnv, description, printDefault, fallback }] of Object.entries(
+    configMappings,
+  )) {
     if (universalOptions.includes(key)) {
       continue;
     }
@@ -45,126 +50,167 @@ export const getOptions = (namespace: string, configMappings: Record<string, Con
       description,
       defaultValue: def,
       printDefault,
-      envVar: env,
+      env: env,
+      fallback,
       parseVal: parseEnv,
     });
   }
   return options;
 };
 
+const configToFlag = (
+  flag: string,
+  configMapping: ConfigMapping<unknown>,
+  overrideDefaultValue?: any,
+): AztecStartOption => {
+  if (!configMapping.isBoolean) {
+    flag += ' <value>';
+  }
+
+  const flagConfig: AztecStartOption = {
+    flag,
+    env: undefined,
+    defaultValue: undefined,
+    parseVal: configMapping.parseEnv,
+    ...configMapping,
+  };
+
+  if (overrideDefaultValue !== undefined) {
+    flagConfig.defaultValue = overrideDefaultValue;
+  }
+
+  return flagConfig;
+};
+
 // These are options used by multiple modules so should be inputted once
-export const universalOptions = ['l1RpcUrls', 'l1ChainId', 'l1Contracts', 'p2pEnabled', 'dataDirectory'];
+export const universalOptions = [
+  'l1ConsensusHostUrls',
+  'l1ConsensusHostApiKeys',
+  'l1ConsensusHostApiKeyHeaders',
+  'p2pEnabled',
+  'fishermanMode',
+  ...getKeys(chainConfigMappings),
+  ...getKeys(l1ContractsConfigMappings),
+  ...getKeys(l1ContractAddressesMapping),
+  ...getKeys(l1ReaderConfigMappings),
+  ...getKeys(dataConfigMappings),
+  ...getKeys(worldStateConfigMappings),
+];
+
+export const NETWORK_FLAG = 'network';
 
 // Define categories and options
 export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
-  NETWORK: [
+  MISC: [
     {
-      flag: '--network <value>',
+      flag: `--${NETWORK_FLAG} <value>`,
       description: 'Network to run Aztec on',
       defaultValue: undefined,
-      envVar: 'NETWORK',
+      env: 'NETWORK',
     },
+
+    configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
+
+    configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
+    configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
+
+    configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode),
   ],
-  SANDBOX: [
+  LOCAL_NETWORK: [
     {
-      flag: '--sandbox',
-      description: 'Starts Aztec Sandbox',
+      flag: '--local-network',
+      description: 'Starts Aztec Local Network',
       defaultValue: undefined,
-      envVar: undefined,
+      env: undefined,
     },
     {
-      flag: '--sandbox.testAccounts',
-      description: 'Deploy test accounts on sandbox start',
-      envVar: 'TEST_ACCOUNTS',
-      ...booleanConfigHelper(true),
+      flag: '--local-network.l1Mnemonic <value>',
+      description: 'Mnemonic for L1 accounts. Will be used ',
+      defaultValue: DefaultMnemonic,
+      env: 'MNEMONIC',
     },
     {
-      flag: '--sandbox.noPXE',
-      description: 'Do not expose PXE service on sandbox start',
-      envVar: 'NO_PXE',
-      ...booleanConfigHelper(),
+      flag: '--local-network.testAccounts',
+      description: 'Deploy test accounts on local network start',
+      env: 'TEST_ACCOUNTS',
+      ...booleanConfigHelper(true),
     },
   ],
   API: [
     {
       flag: '--port <value>',
-      description: 'Port to run the Aztec Services on on',
+      description: 'Port to run the Aztec Services on',
       defaultValue: 8080,
-      envVar: 'AZTEC_PORT',
+      env: 'AZTEC_PORT',
       parseVal: val => parseInt(val, 10),
     },
     {
-      flag: '--api-prefix <value>',
-      description: 'Prefix for API routes on any service that is started',
-      defaultValue: '',
-      envVar: 'API_PREFIX',
-    },
-  ],
-  ETHEREUM: [
-    {
-      flag: '--l1-rpc-urls <value>',
-      description: 'List of URLs of the Ethereum RPC nodes that services will connect to (comma separated)',
-      defaultValue: ['http://localhost:8545'],
-      envVar: 'ETHEREUM_HOSTS',
-      parseVal: (val: string) => val.split(',').map(url => url.trim()),
-    },
-    {
-      flag: '--l1-chain-id <value>',
-      description: 'The L1 chain ID',
-      defaultValue: 31337,
-      envVar: 'L1_CHAIN_ID',
+      flag: '--admin-port <value>',
+      description: 'Port to run admin APIs of Aztec Services on',
+      defaultValue: 8880,
+      env: 'AZTEC_ADMIN_PORT',
       parseVal: val => parseInt(val, 10),
     },
     {
-      flag: '--l1-mnemonic <value>',
-      description: 'Mnemonic for L1 accounts. Will be used if no publisher private keys are provided',
-      defaultValue: DefaultMnemonic,
-      envVar: 'MNEMONIC',
-    },
-  ],
-  'L1 CONTRACT ADDRESSES': [
-    {
-      flag: '--rollup-address <value>',
-      description: 'The deployed L1 rollup contract address',
-      defaultValue: undefined,
-      envVar: 'ROLLUP_CONTRACT_ADDRESS',
-    },
-    {
-      flag: '--registry-address <value>',
-      description: 'The deployed L1 registry contract address',
-      defaultValue: undefined,
-      envVar: 'REGISTRY_CONTRACT_ADDRESS',
-    },
-    {
-      flag: '--inbox-address <value>',
-      description: 'The deployed L1 -> L2 inbox contract address',
+      flag: '--admin-api-key-hash <value>',
+      description:
+        'SHA-256 hex hash of a pre-generated admin API key. When set, the node uses this hash for authentication instead of auto-generating a key.',
       defaultValue: undefined,
-      envVar: 'INBOX_CONTRACT_ADDRESS',
+      env: 'AZTEC_ADMIN_API_KEY_HASH',
     },
     {
-      flag: '--outbox-address <value>',
-      description: 'The deployed L2 -> L1 outbox contract address',
-      defaultValue: undefined,
-      envVar: 'OUTBOX_CONTRACT_ADDRESS',
+      flag: '--disable-admin-api-key',
+      description:
+        'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
+      defaultValue: false,
+      env: 'AZTEC_DISABLE_ADMIN_API_KEY',
+      // undefined means the flag was passed without a value (boolean toggle), treat as true.
+      parseVal: val => val === undefined || val === 'true' || val === '1',
     },
     {
-      flag: '--fee-juice-address <value>',
-      description: 'The deployed L1 Fee Juice contract address',
-      defaultValue: undefined,
-      envVar: 'FEE_JUICE_CONTRACT_ADDRESS',
+      flag: '--reset-admin-api-key',
+      description:
+        'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
+      defaultValue: false,
+      env: 'AZTEC_RESET_ADMIN_API_KEY',
+      parseVal: val => val === 'true' || val === '1',
     },
     {
-      flag: '--staking-asset-address <value>',
-      description: 'The deployed L1 Staking Asset contract address',
-      defaultValue: undefined,
-      envVar: 'STAKING_ASSET_CONTRACT_ADDRESS',
+      flag: '--node-debug',
+      description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
+      defaultValue: false,
+      env: 'AZTEC_NODE_DEBUG',
+      parseVal: val => val === undefined || val === 'true' || val === '1',
     },
     {
-      flag: '--fee-juice-portal-address <value>',
-      description: 'The deployed L1 Fee Juice portal contract address',
-      defaultValue: undefined,
-      envVar: 'FEE_JUICE_PORTAL_CONTRACT_ADDRESS',
+      flag: '--api-prefix <value>',
+      description: 'Prefix for API routes on any service that is started',
+      defaultValue: '',
+      env: 'API_PREFIX',
     },
+    configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
+    configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
+  ],
+  ETHEREUM: [
+    configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
+    // Do not set default for CLI: keep undefined unless provided via flag or env
+    configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
+    configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
+    configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
+    configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
+  ],
+  'L1 CONTRACTS': [
+    configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
+    configToFlag('--rollup-version', chainConfigMappings.rollupVersion),
+  ],
+  STORAGE: [
+    configToFlag('--data-directory', dataConfigMappings.dataDirectory),
+    configToFlag('--data-store-map-size-kb', dataConfigMappings.dataStoreMapSizeKb),
+  ],
+  'WORLD STATE': [
+    configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
+    configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
+    configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
   ],
   // We can't easily auto-generate node options as they're parts of modules defined below
   'AZTEC NODE': [
@@ -172,129 +218,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
       flag: '--node',
       description: 'Starts Aztec Node with options',
       defaultValue: undefined,
-      envVar: undefined,
-    },
-    {
-      flag: '--data-directory <value>',
-      description: 'Where to store data. If not set, will store temporarily',
-      defaultValue: undefined,
-      envVar: 'DATA_DIRECTORY',
-    },
-    {
-      flag: '--node.archiverUrl <value>',
-      description: 'URL for an archiver service',
-      defaultValue: undefined,
-      envVar: 'ARCHIVER_URL',
-    },
-    {
-      flag: '--node.deployAztecContracts',
-      description: 'Deploys L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set.',
-      envVar: 'DEPLOY_AZTEC_CONTRACTS',
-      defaultValue: undefined,
-    },
-    {
-      flag: '--node.deployAztecContractsSalt <value>',
-      description:
-        'Numeric salt for deploying L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set. Implies --node.deployAztecContracts.',
-      envVar: 'DEPLOY_AZTEC_CONTRACTS_SALT',
-      defaultValue: undefined,
-      parseVal: (val: string) => (val ? parseInt(val) : undefined),
-    },
-    {
-      flag: '--node.assumeProvenThroughBlockNumber <value>',
-      description:
-        'Cheats the rollup contract into assuming every block until this one is proven. Useful for speeding up bootstraps.',
-      envVar: 'ASSUME_PROVEN_THROUGH_BLOCK_NUMBER',
-      parseVal: (val: string) => parseInt(val, 10),
-      defaultValue: 0,
-    },
-    {
-      flag: '--node.publisherPrivateKey <value>',
-      description: 'Private key of account for publishing L1 contracts',
-      defaultValue: undefined,
-      envVar: 'L1_PRIVATE_KEY',
-    },
-    {
-      flag: '--node.worldStateBlockCheckIntervalMS <value>',
-      description: 'Frequency in which to check for blocks in ms',
-      defaultValue: 100,
-      envVar: 'WS_BLOCK_CHECK_INTERVAL_MS',
-      parseVal: val => parseInt(val, 10),
-    },
-    {
-      flag: '--node.testAccounts',
-      description: 'Populate genesis state with initial fee juice for test accounts',
-      envVar: 'TEST_ACCOUNTS',
-      ...booleanConfigHelper(),
+      env: undefined,
     },
   ],
-  'P2P SUBSYSTEM': [
-    {
-      flag: '--p2p-enabled',
-      description: 'Enable P2P subsystem',
-      envVar: 'P2P_ENABLED',
-      ...booleanConfigHelper(),
-    },
-    ...getOptions('p2p', p2pConfigMappings),
-  ],
-  TELEMETRY: [...getOptions('tel', telemetryClientConfigMappings)],
-  PXE: [
-    {
-      flag: '--pxe',
-      description: 'Starts Aztec PXE with options',
-      defaultValue: undefined,
-      envVar: undefined,
-    },
-    ...getOptions('pxe', allPxeConfigMappings),
-  ],
   ARCHIVER: [
-    {
-      flag: '--archiver',
-      description: 'Starts Aztec Archiver with options',
-      defaultValue: undefined,
-      envVar: undefined,
-    },
-    // filter out archiverUrl as it's passed separately in --node & --prover-node
-    ...getOptions('archiver', archiverConfigMappings).filter(opt => !opt.flag.includes('archiverUrl')),
+    ...getOptions(
+      'archiver',
+      omitConfigMappings(archiverConfigMappings, Object.keys(l1ContractsConfigMappings) as (keyof ArchiverConfig)[]),
+    ),
   ],
   SEQUENCER: [
     {
       flag: '--sequencer',
       description: 'Starts Aztec Sequencer with options',
       defaultValue: undefined,
-      envVar: undefined,
-    },
-    ...getOptions('sequencer', sequencerClientConfigMappings),
-  ],
-  BLOB_SINK: [
-    {
-      flag: '--blob-sink',
-      description: 'Starts Aztec Blob Sink with options',
-      defaultValue: undefined,
-      envVar: undefined,
+      env: undefined,
     },
-    ...getOptions('blobSink', blobSinkConfigMappings),
+    ...getOptions(
+      'sequencer',
+      omitConfigMappings(sequencerClientConfigMappings, [
+        'fakeProcessingDelayPerTxMs',
+        'fakeThrowAfterProcessingTxCount',
+        'skipCollectingAttestations',
+        'skipInvalidateBlockAsProposer',
+        'blobSinkMapSizeKb',
+      ]),
+    ),
   ],
   'PROVER NODE': [
     {
       flag: '--prover-node',
       description: 'Starts Aztec Prover Node with options',
       defaultValue: undefined,
-      envVar: undefined,
-    },
-    {
-      flag: '--proverNode.archiverUrl <value>',
-      description: 'URL for an archiver service',
-      defaultValue: undefined,
-      envVar: 'ARCHIVER_URL',
+      env: undefined,
     },
     ...getOptions(
       'proverNode',
       omitConfigMappings(proverNodeConfigMappings, [
         // filter out options passed separately
-        ...(Object.keys(archiverConfigMappings) as (keyof ArchiverConfig)[]),
-        ...(Object.keys(proverBrokerConfigMappings) as (keyof ProverBrokerConfig)[]),
-        ...(Object.keys(proverAgentConfigMappings) as (keyof ProverAgentConfig)[]),
+        ...getKeys(proverBrokerConfigMappings),
+        ...getKeys(proverAgentConfigMappings),
       ]),
     ),
   ],
@@ -303,69 +266,63 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
       flag: '--prover-broker',
       description: 'Starts Aztec proving job broker',
       defaultValue: undefined,
-      envVar: undefined,
+      env: undefined,
     },
-    ...getOptions(
-      'proverBroker',
-      // filter out archiver options from prover node options as they're passed separately in --archiver
-      proverBrokerConfigMappings,
-    ),
+    ...getOptions('proverBroker', proverBrokerConfigMappings),
   ],
   'PROVER AGENT': [
     {
       flag: '--prover-agent',
       description: 'Starts Aztec Prover Agent with options',
       defaultValue: undefined,
-      envVar: undefined,
+      env: undefined,
     },
     ...getOptions('proverAgent', proverAgentConfigMappings),
   ],
+  'P2P SUBSYSTEM': [
+    {
+      flag: '--p2p-enabled [value]',
+      description: 'Enable P2P subsystem',
+      env: 'P2P_ENABLED',
+      ...booleanConfigHelper(),
+    },
+    ...getOptions('p2p', p2pConfigMappings),
+  ],
   'P2P BOOTSTRAP': [
     {
       flag: '--p2p-bootstrap',
       description: 'Starts Aztec P2P Bootstrap with options',
       defaultValue: undefined,
-      envVar: undefined,
+      env: undefined,
     },
-    ...getOptions('p2pBootstrap', bootnodeConfigMappings),
+    ...getOptions(
+      'p2pBootstrap',
+      omitConfigMappings(bootnodeConfigMappings, [
+        'p2pIp',
+        'p2pPort',
+        'peerIdPrivateKey',
+        'bootstrapNodes',
+        'listenAddress',
+      ]),
+    ),
   ],
+  TELEMETRY: [...getOptions('tel', telemetryClientConfigMappings)],
   BOT: [
     {
       flag: '--bot',
       description: 'Starts Aztec Bot with options',
       defaultValue: undefined,
-      envVar: undefined,
+      env: undefined,
     },
     ...getOptions('bot', botConfigMappings),
   ],
+  PXE: [...getOptions('pxe', allPxeConfigMappings)],
   TXE: [
     {
       flag: '--txe',
       description: 'Starts Aztec TXE with options',
       defaultValue: undefined,
-      envVar: undefined,
-    },
-  ],
-  FAUCET: [
-    {
-      flag: '--faucet',
-      description: 'Starts the Aztec faucet',
-      defaultValue: undefined,
-      envVar: undefined,
-    },
-    {
-      flag: '--faucet.apiServer',
-      description: 'Starts a simple HTTP server to access the faucet',
-      defaultValue: true,
-      envVar: undefined,
-    },
-    {
-      flag: '--faucet.apiServerPort <value>',
-      description: 'The port on which to start the api server on',
-      defaultValue: 8080,
-      envVar: undefined,
-      parseVal: val => parseInt(val, 10),
+      env: undefined,
     },
-    ...getOptions('faucet', faucetConfigMapping),
   ],
 };

package/src/cli/cli.ts

@@ -31,18 +31,26 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
 
   program.configureHelp({ sortSubcommands: true });
 
-  program.addHelpText(
-    'after',
-    `
-
-  Additional commands:
-
-    test [options]: starts a dockerized TXE node via
-      $ aztec start --txe
-    then runs
-      $ aztec-nargo test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
+  if (process.env.AZTEC_SHELL_WRAPPER) {
+    program.addHelpText(
+      'after',
+      `
+Additional commands:
+
+  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.
     `,
-  );
+    );
+  }
+
+  program
+    .command('preload-crs')
+    .description('Preload the points data needed for proving and verifying')
+    .action(async options => {
+      const { preloadCrs } = await import('./preload_crs.js');
+      return await preloadCrs(options, userLog, debugLogger);
+    });
 
   return program;
 }