@aztec/aztec 0.0.1-commit.b655e406 → 0.0.1-commit.c0b82b2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. package/README.md +1 -1
  2. package/dest/bin/index.d.ts +1 -1
  3. package/dest/bin/index.js +11 -4
  4. package/dest/cli/admin_api_key_store.d.ts +45 -0
  5. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  6. package/dest/cli/admin_api_key_store.js +98 -0
  7. package/dest/cli/aztec_start_action.d.ts +1 -1
  8. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  9. package/dest/cli/aztec_start_action.js +58 -21
  10. package/dest/cli/aztec_start_options.d.ts +1 -1
  11. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  12. package/dest/cli/aztec_start_options.js +46 -38
  13. package/dest/cli/cli.d.ts +1 -1
  14. package/dest/cli/cli.js +7 -7
  15. package/dest/cli/cmds/compile.d.ts +4 -0
  16. package/dest/cli/cmds/compile.d.ts.map +1 -0
  17. package/dest/cli/cmds/compile.js +160 -0
  18. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  19. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  20. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  21. package/dest/cli/cmds/profile.d.ts +4 -0
  22. package/dest/cli/cmds/profile.d.ts.map +1 -0
  23. package/dest/cli/cmds/profile.js +8 -0
  24. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  25. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  26. package/dest/cli/cmds/profile_flamegraph.js +51 -0
  27. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  28. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  29. package/dest/cli/cmds/profile_gates.js +57 -0
  30. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  31. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  32. package/dest/cli/cmds/profile_utils.js +50 -0
  33. package/dest/cli/cmds/start_archiver.d.ts +1 -1
  34. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  35. package/dest/cli/cmds/start_archiver.js +11 -13
  36. package/dest/cli/cmds/start_bot.d.ts +3 -3
  37. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  38. package/dest/cli/cmds/start_bot.js +10 -6
  39. package/dest/cli/cmds/start_node.d.ts +1 -1
  40. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  41. package/dest/cli/cmds/start_node.js +66 -14
  42. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  43. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  44. package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
  45. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  46. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  47. package/dest/cli/cmds/start_prover_agent.js +4 -4
  48. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  49. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  50. package/dest/cli/cmds/start_prover_broker.js +4 -4
  51. package/dest/cli/cmds/start_txe.d.ts +1 -1
  52. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  53. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  54. package/dest/cli/cmds/utils/artifacts.js +24 -0
  55. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  56. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  57. package/dest/cli/cmds/utils/spawn.js +16 -0
  58. package/dest/cli/index.d.ts +1 -1
  59. package/dest/cli/preload_crs.d.ts +1 -1
  60. package/dest/cli/release_version.d.ts +1 -1
  61. package/dest/cli/util.d.ts +11 -20
  62. package/dest/cli/util.d.ts.map +1 -1
  63. package/dest/cli/util.js +16 -11
  64. package/dest/cli/versioning.d.ts +1 -1
  65. package/dest/examples/token.d.ts +1 -1
  66. package/dest/examples/token.js +6 -6
  67. package/dest/examples/util.d.ts +2 -2
  68. package/dest/examples/util.d.ts.map +1 -1
  69. package/dest/index.d.ts +2 -2
  70. package/dest/index.d.ts.map +1 -1
  71. package/dest/index.js +1 -1
  72. package/dest/local-network/banana_fpc.d.ts +10 -0
  73. package/dest/local-network/banana_fpc.d.ts.map +1 -0
  74. package/dest/{sandbox → local-network}/banana_fpc.js +3 -3
  75. package/dest/local-network/index.d.ts +4 -0
  76. package/dest/local-network/index.d.ts.map +1 -0
  77. package/dest/{sandbox → local-network}/index.js +1 -1
  78. package/dest/local-network/local-network.d.ts +73 -0
  79. package/dest/local-network/local-network.d.ts.map +1 -0
  80. package/dest/{sandbox/sandbox.js → local-network/local-network.js} +75 -45
  81. package/dest/local-network/sponsored_fpc.d.ts +5 -0
  82. package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
  83. package/dest/mnemonic.d.ts +1 -1
  84. package/dest/splash.d.ts +1 -1
  85. package/dest/testing/anvil_test_watcher.d.ts +12 -4
  86. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  87. package/dest/testing/anvil_test_watcher.js +68 -29
  88. package/dest/testing/cheat_codes.d.ts +1 -1
  89. package/dest/testing/cheat_codes.d.ts.map +1 -1
  90. package/dest/testing/epoch_test_settler.d.ts +19 -0
  91. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  92. package/dest/testing/epoch_test_settler.js +62 -0
  93. package/dest/testing/index.d.ts +2 -1
  94. package/dest/testing/index.d.ts.map +1 -1
  95. package/dest/testing/index.js +1 -0
  96. package/package.json +41 -37
  97. package/scripts/aztec.sh +66 -0
  98. package/scripts/init.sh +45 -0
  99. package/scripts/new.sh +60 -0
  100. package/scripts/setup_workspace.sh +124 -0
  101. package/src/bin/index.ts +12 -4
  102. package/src/cli/admin_api_key_store.ts +128 -0
  103. package/src/cli/aztec_start_action.ts +61 -16
  104. package/src/cli/aztec_start_options.ts +47 -36
  105. package/src/cli/cli.ts +11 -11
  106. package/src/cli/cmds/compile.ts +184 -0
  107. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  108. package/src/cli/cmds/profile.ts +25 -0
  109. package/src/cli/cmds/profile_flamegraph.ts +63 -0
  110. package/src/cli/cmds/profile_gates.ts +67 -0
  111. package/src/cli/cmds/profile_utils.ts +58 -0
  112. package/src/cli/cmds/start_archiver.ts +7 -18
  113. package/src/cli/cmds/start_bot.ts +9 -6
  114. package/src/cli/cmds/start_node.ts +55 -13
  115. package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
  116. package/src/cli/cmds/start_prover_agent.ts +4 -12
  117. package/src/cli/cmds/start_prover_broker.ts +7 -3
  118. package/src/cli/cmds/utils/artifacts.ts +44 -0
  119. package/src/cli/cmds/utils/spawn.ts +16 -0
  120. package/src/cli/util.ts +22 -27
  121. package/src/examples/token.ts +6 -8
  122. package/src/examples/util.ts +1 -1
  123. package/src/index.ts +2 -2
  124. package/src/{sandbox → local-network}/banana_fpc.ts +11 -7
  125. package/src/{sandbox → local-network}/index.ts +1 -1
  126. package/src/local-network/local-network.ts +267 -0
  127. package/src/{sandbox → local-network}/sponsored_fpc.ts +3 -2
  128. package/src/testing/anvil_test_watcher.ts +76 -30
  129. package/src/testing/cheat_codes.ts +3 -2
  130. package/src/testing/epoch_test_settler.ts +71 -0
  131. package/src/testing/index.ts +1 -0
  132. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  133. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  134. package/dest/cli/cmds/start_blob_sink.js +0 -33
  135. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  136. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  137. package/dest/cli/cmds/start_prover_node.js +0 -108
  138. package/dest/sandbox/banana_fpc.d.ts +0 -10
  139. package/dest/sandbox/banana_fpc.d.ts.map +0 -1
  140. package/dest/sandbox/index.d.ts +0 -4
  141. package/dest/sandbox/index.d.ts.map +0 -1
  142. package/dest/sandbox/sandbox.d.ts +0 -74
  143. package/dest/sandbox/sandbox.d.ts.map +0 -1
  144. package/dest/sandbox/sponsored_fpc.d.ts +0 -4
  145. package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
  146. package/src/cli/cmds/start_blob_sink.ts +0 -57
  147. package/src/cli/cmds/start_prover_node.ts +0 -124
  148. package/src/sandbox/sandbox.ts +0 -242
  149. /package/dest/{sandbox → local-network}/sponsored_fpc.js +0 -0
@@ -0,0 +1,128 @@
1
+ import { randomBytes } from '@aztec/foundation/crypto/random';
2
+ import { sha256Hash } from '@aztec/foundation/json-rpc/server';
3
+ import type { Logger } from '@aztec/foundation/log';
4
+
5
+ import { promises as fs } from 'fs';
6
+ import { join } from 'path';
7
+
8
+ /** Subdirectory under dataDirectory for admin API key storage. */
9
+ const ADMIN_STORE_DIR = 'admin';
10
+ const HASH_FILE_NAME = 'api_key_hash';
11
+
12
+ /**
13
+ * Result of resolving the admin API key.
14
+ * Contains the SHA-256 hex hash of the API key to be used by the auth middleware,
15
+ * and optionally the raw key when newly generated (so the caller can display it).
16
+ */
17
+ export interface AdminApiKeyResolution {
18
+ /** The SHA-256 hash of the API key. */
19
+ apiKeyHash: Buffer;
20
+ /**
21
+ * The raw API key, only present when a new key was generated during this call.
22
+ * The caller MUST display this to the operator — it will not be stored or returned again.
23
+ */
24
+ rawKey?: string;
25
+ }
26
+
27
+ export interface ResolveAdminApiKeyOptions {
28
+ /** SHA-256 hex hash of a pre-generated API key. When set, the node uses this hash directly. */
29
+ adminApiKeyHash?: string;
30
+ /** If true, disable admin API key auth entirely. */
31
+ disableAdminApiKey?: boolean;
32
+ /** If true, force-generate a new key even if one is already persisted. */
33
+ resetAdminApiKey?: boolean;
34
+ /** Root data directory for persistent storage. */
35
+ dataDirectory?: string;
36
+ }
37
+
38
+ /**
39
+ * Resolves the admin API key for the admin RPC endpoint.
40
+ *
41
+ * Strategy:
42
+ * 1. If opt-out flag is set (`disableAdminApiKey`), return undefined (no auth).
43
+ * 2. If a pre-generated hash is provided (`adminApiKeyHash`), use it directly.
44
+ * 3. If a data directory exists, look for a persisted hash file
45
+ * at `<dataDirectory>/admin/api_key_hash`:
46
+ * - If `resetAdminApiKey` is set, skip loading and force-generate a new key.
47
+ * - Found: use the stored hash (operator already saved the key from first run).
48
+ * - Not found: auto-generate a random key, display it once, persist the hash.
49
+ * 3. If no data directory: generate a random key
50
+ * each run and display it (cannot persist).
51
+ *
52
+ * @param options - The options for resolving the admin API key.
53
+ * @param log - Logger for outputting the key and status messages.
54
+ * @returns The resolved API key hash, or undefined if auth is disabled.
55
+ */
56
+ export async function resolveAdminApiKey(
57
+ options: ResolveAdminApiKeyOptions,
58
+ log: Logger,
59
+ ): Promise<AdminApiKeyResolution | undefined> {
60
+ // Operator explicitly opted out of admin auth
61
+ if (options.disableAdminApiKey) {
62
+ log.warn('Admin API key authentication is DISABLED (--disable-admin-api-key / AZTEC_DISABLE_ADMIN_API_KEY)');
63
+ return undefined;
64
+ }
65
+
66
+ // Operator provided a pre-generated hash (e.g. via AZTEC_ADMIN_API_KEY_HASH env var)
67
+ if (options.adminApiKeyHash) {
68
+ const hex = options.adminApiKeyHash.trim();
69
+ if (hex.length !== 64 || !/^[0-9a-f]{64}$/.test(hex)) {
70
+ throw new Error(`Invalid admin API key hash: expected 64-char hex string, got "${hex}"`);
71
+ }
72
+ log.info('Admin API key authentication enabled (using pre-configured key hash)');
73
+ return { apiKeyHash: Buffer.from(hex, 'hex') };
74
+ }
75
+
76
+ // Persistent storage available, load or generate key
77
+ if (options.dataDirectory) {
78
+ const adminDir = join(options.dataDirectory, ADMIN_STORE_DIR);
79
+ const hashFilePath = join(adminDir, HASH_FILE_NAME);
80
+
81
+ // Unless a reset is forced, try to load the existing hash from disk
82
+ if (!options.resetAdminApiKey) {
83
+ try {
84
+ const storedHash = (await fs.readFile(hashFilePath, 'utf-8')).trim();
85
+ if (storedHash.length === 64) {
86
+ log.info('Admin API key authentication enabled (loaded stored key hash from disk)');
87
+ return { apiKeyHash: Buffer.from(storedHash, 'hex') };
88
+ }
89
+ log.warn(`Invalid stored admin API key hash at ${hashFilePath}, regenerating...`);
90
+ } catch (err: any) {
91
+ if (err.code !== 'ENOENT') {
92
+ log.warn(`Failed to read admin API key hash from ${hashFilePath}: ${err.message}`);
93
+ }
94
+ // File doesn't exist — fall through to generate
95
+ }
96
+ } else {
97
+ log.warn('Admin API key reset requested — generating a new key');
98
+ }
99
+
100
+ // Generate a new key, persist the hash, and return the raw key for the caller to display
101
+ const { rawKey, hash } = generateApiKey();
102
+ await fs.mkdir(adminDir, { recursive: true });
103
+ await fs.writeFile(hashFilePath, hash.toString('hex'), 'utf-8');
104
+ // Set restrictive permissions (owner read/write only)
105
+ await fs.chmod(hashFilePath, 0o600);
106
+
107
+ log.info('Admin API key authentication enabled (new key generated and hash persisted to disk)');
108
+ return { apiKeyHash: hash, rawKey };
109
+ }
110
+
111
+ // No data directory, generate a temporary key per session
112
+ const { rawKey, hash } = generateApiKey();
113
+
114
+ log.warn('No data directory configured — admin API key cannot be persisted.');
115
+ log.warn('A temporary key has been generated for this session only.');
116
+
117
+ return { apiKeyHash: hash, rawKey };
118
+ }
119
+
120
+ /**
121
+ * Generates a cryptographically random API key and its SHA-256 hash.
122
+ * @returns The raw key (hex string) and its SHA-256 hash as a Buffer.
123
+ */
124
+ function generateApiKey(): { rawKey: string; hash: Buffer } {
125
+ const rawKey = randomBytes(32).toString('hex');
126
+ const hash = sha256Hash(rawKey);
127
+ return { rawKey, hash };
128
+ }
@@ -1,6 +1,7 @@
1
1
  import {
2
2
  type NamespacedApiHandlers,
3
3
  createNamespacedSafeJsonRpcServer,
4
+ getApiKeyAuthMiddleware,
4
5
  startHttpRpcServer,
5
6
  } from '@aztec/foundation/json-rpc/server';
6
7
  import type { LogFn, Logger } from '@aztec/foundation/log';
@@ -9,8 +10,9 @@ import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
9
10
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
10
11
  import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
12
 
12
- import { createSandbox } from '../sandbox/index.js';
13
+ import { createLocalNetwork } from '../local-network/index.js';
13
14
  import { github, splash } from '../splash.js';
15
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
14
16
  import { getCliVersion } from './release_version.js';
15
17
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
16
18
  import { getVersions } from './versioning.js';
@@ -22,20 +24,24 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
22
24
  const adminServices: NamespacedApiHandlers = {};
23
25
  let config: ChainConfig | undefined = undefined;
24
26
 
25
- if (options.sandbox) {
27
+ if (options.localNetwork) {
26
28
  const cliVersion = getCliVersion();
27
- const sandboxOptions = extractNamespacedOptions(options, 'sandbox');
28
- sandboxOptions.testAccounts = true;
29
+ const localNetwork = extractNamespacedOptions(options, 'local-network');
30
+ localNetwork.testAccounts = true;
29
31
  userLog(`${splash}\n${github}\n\n`);
30
- userLog(`Setting up Aztec Sandbox ${cliVersion}, please stand by...`);
32
+ userLog(`Setting up Aztec local network ${cliVersion}, please stand by...`);
31
33
 
32
- const { node, stop } = await createSandbox(
34
+ const { node, stop } = await createLocalNetwork(
33
35
  {
34
- l1Mnemonic: sandboxOptions.l1Mnemonic,
36
+ l1Mnemonic: localNetwork.l1Mnemonic,
35
37
  l1RpcUrls: options.l1RpcUrls,
36
- deployAztecContractsSalt: sandboxOptions.deployAztecContractsSalt,
37
- testAccounts: sandboxOptions.testAccounts,
38
+ testAccounts: localNetwork.testAccounts,
38
39
  realProofs: false,
40
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
41
+ // the users can consume out hash without having to wait for a long time.
42
+ // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
43
+ // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
44
+ aztecEpochDuration: 2,
39
45
  },
40
46
  userLog,
41
47
  );
@@ -44,18 +50,17 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
44
50
  signalHandlers.push(stop);
45
51
  services.node = [node, AztecNodeApiSchema];
46
52
  } else {
53
+ // Route --prover-node through startNode
54
+ if (options.proverNode && !options.node) {
55
+ options.node = true;
56
+ }
57
+
47
58
  if (options.node) {
48
59
  const { startNode } = await import('./cmds/start_node.js');
49
60
  ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
50
61
  } else if (options.bot) {
51
62
  const { startBot } = await import('./cmds/start_bot.js');
52
63
  await startBot(options, signalHandlers, services, userLog);
53
- } else if (options.proverNode) {
54
- const { startProverNode } = await import('./cmds/start_prover_node.js');
55
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
56
- } else if (options.blobSink) {
57
- const { startBlobSink } = await import('./cmds/start_blob_sink.js');
58
- await startBlobSink(options, signalHandlers, userLog);
59
64
  } else if (options.archiver) {
60
65
  const { startArchiver } = await import('./cmds/start_archiver.js');
61
66
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -98,14 +103,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
98
103
 
99
104
  // If there are any admin services, start a separate JSON-RPC server for them
100
105
  if (Object.entries(adminServices).length > 0) {
106
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
107
+
108
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
109
+ const apiKeyResolution = await resolveAdminApiKey(
110
+ {
111
+ adminApiKeyHash: options.adminApiKeyHash,
112
+ disableAdminApiKey: options.disableAdminApiKey,
113
+ resetAdminApiKey: options.resetAdminApiKey,
114
+ dataDirectory: options.dataDirectory,
115
+ },
116
+ debugLogger,
117
+ );
118
+ if (apiKeyResolution) {
119
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
120
+ } else {
121
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
122
+ }
123
+
101
124
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
102
125
  http200OnError: false,
103
126
  log: debugLogger,
104
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
127
+ middlewares: adminMiddlewares,
105
128
  maxBatchSize: options.rpcMaxBatchSize,
106
129
  maxBodySizeBytes: options.rpcMaxBodySize,
107
130
  });
108
131
  const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
109
132
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
133
+
134
+ // Display the API key after the server has started
135
+ // Uses userLog which is never filtered by LOG_LEVEL.
136
+ if (apiKeyResolution?.rawKey) {
137
+ const separator = '='.repeat(70);
138
+ userLog('');
139
+ userLog(separator);
140
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
141
+ userLog('');
142
+ userLog(` ${apiKeyResolution.rawKey}`);
143
+ userLog('');
144
+ userLog(` Use via header: x-api-key: <key>`);
145
+ userLog(` Or via header: Authorization: Bearer <key>`);
146
+ if (options.dataDirectory) {
147
+ userLog('');
148
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
149
+ }
150
+ userLog('');
151
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
152
+ userLog(separator);
153
+ userLog('');
154
+ }
110
155
  }
111
156
  }
@@ -1,8 +1,9 @@
1
1
  import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
2
- import { sequencerClientConfigMappings } from '@aztec/aztec-node/config';
3
- import { blobSinkConfigMappings } from '@aztec/blob-sink/server';
2
+ import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
4
3
  import { botConfigMappings } from '@aztec/bot/config';
5
- import { l1ContractAddressesMapping, l1ContractsConfigMappings, l1ReaderConfigMappings } from '@aztec/ethereum';
4
+ import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
5
+ import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
6
+ import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
6
7
  import { getKeys } from '@aztec/foundation/collection';
7
8
  import {
8
9
  type ConfigMapping,
@@ -14,12 +15,13 @@ import {
14
15
  import { dataConfigMappings } from '@aztec/kv-store/config';
15
16
  import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
16
17
  import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
17
- import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
18
+ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
18
19
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
19
20
  import { allPxeConfigMappings } from '@aztec/pxe/config';
20
- import { chainConfigMappings } from '@aztec/stdlib/config';
21
- import { telemetryClientConfigMappings } from '@aztec/telemetry-client';
22
- import { worldStateConfigMappings } from '@aztec/world-state';
21
+ import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
22
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
23
+ import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
24
+ import { worldStateConfigMappings } from '@aztec/world-state/config';
23
25
 
24
26
  import { DefaultMnemonic } from '../mnemonic.js';
25
27
 
@@ -82,6 +84,7 @@ export const universalOptions = [
82
84
  'l1ConsensusHostApiKeys',
83
85
  'l1ConsensusHostApiKeyHeaders',
84
86
  'p2pEnabled',
87
+ 'fishermanMode',
85
88
  ...getKeys(chainConfigMappings),
86
89
  ...getKeys(l1ContractsConfigMappings),
87
90
  ...getKeys(l1ContractAddressesMapping),
@@ -107,28 +110,22 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
107
110
 
108
111
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
109
112
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
113
+
114
+ configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode),
110
115
  ],
111
- SANDBOX: [
116
+ LOCAL_NETWORK: [
112
117
  {
113
- flag: '--sandbox',
114
- description: 'Starts Aztec Sandbox',
118
+ flag: '--local-network',
119
+ description: 'Starts Aztec Local Network',
115
120
  defaultValue: undefined,
116
121
  env: undefined,
117
122
  },
118
123
  {
119
- flag: '--sandbox.l1Mnemonic <value>',
124
+ flag: '--local-network.l1Mnemonic <value>',
120
125
  description: 'Mnemonic for L1 accounts. Will be used ',
121
126
  defaultValue: DefaultMnemonic,
122
127
  env: 'MNEMONIC',
123
128
  },
124
- {
125
- flag: '--sandbox.deployAztecContractsSalt <value>',
126
- description:
127
- 'Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set.',
128
- env: 'DEPLOY_AZTEC_CONTRACTS_SALT',
129
- defaultValue: undefined,
130
- parseVal: (val: string) => (val ? parseInt(val) : undefined),
131
- },
132
129
  ],
133
130
  API: [
134
131
  {
@@ -145,20 +142,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
145
142
  env: 'AZTEC_ADMIN_PORT',
146
143
  parseVal: val => parseInt(val, 10),
147
144
  },
145
+ {
146
+ flag: '--admin-api-key-hash <value>',
147
+ description:
148
+ '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.',
149
+ defaultValue: undefined,
150
+ env: 'AZTEC_ADMIN_API_KEY_HASH',
151
+ },
152
+ {
153
+ flag: '--disable-admin-api-key',
154
+ description:
155
+ 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
156
+ defaultValue: false,
157
+ env: 'AZTEC_DISABLE_ADMIN_API_KEY',
158
+ // undefined means the flag was passed without a value (boolean toggle), treat as true.
159
+ parseVal: val => val === undefined || val === 'true' || val === '1',
160
+ },
161
+ {
162
+ flag: '--reset-admin-api-key',
163
+ description:
164
+ 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
165
+ defaultValue: false,
166
+ env: 'AZTEC_RESET_ADMIN_API_KEY',
167
+ parseVal: val => val === 'true' || val === '1',
168
+ },
148
169
  {
149
170
  flag: '--api-prefix <value>',
150
171
  description: 'Prefix for API routes on any service that is started',
151
172
  defaultValue: '',
152
173
  env: 'API_PREFIX',
153
174
  },
175
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
176
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
154
177
  ],
155
178
  ETHEREUM: [
156
179
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
157
180
  // Do not set default for CLI: keep undefined unless provided via flag or env
158
181
  configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
159
- configToFlag('--l1-consensus-host-urls', blobSinkConfigMappings.l1ConsensusHostUrls),
160
- configToFlag('--l1-consensus-host-api-keys', blobSinkConfigMappings.l1ConsensusHostApiKeys),
161
- configToFlag('--l1-consensus-host-api-key-headers', blobSinkConfigMappings.l1ConsensusHostApiKeyHeaders),
182
+ configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
183
+ configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
184
+ configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
162
185
  ],
163
186
  'L1 CONTRACTS': [
164
187
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -171,7 +194,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
171
194
  'WORLD STATE': [
172
195
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
173
196
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
174
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
197
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
175
198
  ],
176
199
  // We can't easily auto-generate node options as they're parts of modules defined below
177
200
  'AZTEC NODE': [
@@ -205,21 +228,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
205
228
  'sequencer',
206
229
  omitConfigMappings(sequencerClientConfigMappings, [
207
230
  'fakeProcessingDelayPerTxMs',
231
+ 'fakeThrowAfterProcessingTxCount',
208
232
  'skipCollectingAttestations',
209
233
  'skipInvalidateBlockAsProposer',
210
234
  'blobSinkMapSizeKb',
211
235
  ]),
212
236
  ),
213
237
  ],
214
- 'BLOB SINK': [
215
- {
216
- flag: '--blob-sink',
217
- description: 'Starts Aztec Blob Sink with options',
218
- defaultValue: undefined,
219
- env: undefined,
220
- },
221
- ...getOptions('blobSink', blobSinkConfigMappings),
222
- ],
223
238
  'PROVER NODE': [
224
239
  {
225
240
  flag: '--prover-node',
@@ -231,12 +246,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
231
246
  'proverNode',
232
247
  omitConfigMappings(proverNodeConfigMappings, [
233
248
  // filter out options passed separately
234
- ...getKeys(archiverConfigMappings),
235
249
  ...getKeys(proverBrokerConfigMappings),
236
250
  ...getKeys(proverAgentConfigMappings),
237
- ...getKeys(p2pConfigMappings),
238
- ...getKeys(worldStateConfigMappings),
239
- ...getKeys(sharedNodeConfigMappings),
240
251
  ]),
241
252
  ),
242
253
  ],
package/src/cli/cli.ts CHANGED
@@ -31,18 +31,18 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
31
31
 
32
32
  program.configureHelp({ sortSubcommands: true });
33
33
 
34
- program.addHelpText(
35
- 'after',
36
- `
37
-
38
- Additional commands:
39
-
40
- test [options]: starts a dockerized TXE node via
41
- $ aztec start --txe
42
- then runs
43
- $ aztec-nargo test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
34
+ if (process.env.AZTEC_SHELL_WRAPPER) {
35
+ program.addHelpText(
36
+ 'after',
37
+ `
38
+ Additional commands:
39
+
40
+ init [folder] [options] creates a new Aztec Noir project.
41
+ new <path> [options] creates a new Aztec Noir project in a new directory.
42
+ test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
44
43
  `,
45
- );
44
+ );
45
+ }
46
46
 
47
47
  program
48
48
  .command('preload-crs')
@@ -0,0 +1,184 @@
1
+ import type { LogFn } from '@aztec/foundation/log';
2
+
3
+ import { execFileSync } from 'child_process';
4
+ import type { Command } from 'commander';
5
+ import { readFile, writeFile } from 'fs/promises';
6
+ import { join } from 'path';
7
+
8
+ import { readArtifactFiles } from './utils/artifacts.js';
9
+ import { run } from './utils/spawn.js';
10
+
11
+ /** Returns paths to contract artifacts in the target directory. */
12
+ async function collectContractArtifacts(): Promise<string[]> {
13
+ let files;
14
+ try {
15
+ files = await readArtifactFiles('target');
16
+ } catch (err: any) {
17
+ if (err?.message?.includes('does not exist')) {
18
+ return [];
19
+ }
20
+ throw err;
21
+ }
22
+ return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
23
+ }
24
+
25
+ /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
26
+ async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
27
+ for (const path of artifactPaths) {
28
+ const artifact = JSON.parse(await readFile(path, 'utf-8'));
29
+ for (const fn of artifact.functions) {
30
+ if (typeof fn.name === 'string') {
31
+ fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
32
+ }
33
+ }
34
+ await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
35
+ }
36
+ }
37
+
38
+ /** Returns the set of package names that are contract crates in the current workspace. */
39
+ async function getContractPackageNames(): Promise<Set<string>> {
40
+ const contractNames = new Set<string>();
41
+
42
+ let rootToml: string;
43
+ try {
44
+ rootToml = await readFile('Nargo.toml', 'utf-8');
45
+ } catch {
46
+ return contractNames;
47
+ }
48
+
49
+ const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
50
+ if (membersMatch) {
51
+ const members = membersMatch[1]
52
+ .split(',')
53
+ .map(m => m.trim().replace(/^"|"$/g, ''))
54
+ .filter(m => m.length > 0);
55
+
56
+ for (const member of members) {
57
+ try {
58
+ const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
59
+ if (/type\s*=\s*"contract"/.test(memberToml)) {
60
+ const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
61
+ if (nameMatch) {
62
+ contractNames.add(nameMatch[1]);
63
+ }
64
+ }
65
+ } catch {
66
+ // Member directory might not exist or have no Nargo.toml; skip.
67
+ }
68
+ }
69
+ } else {
70
+ // Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
71
+ if (/type\s*=\s*"contract"/.test(rootToml)) {
72
+ const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
73
+ if (nameMatch) {
74
+ contractNames.add(nameMatch[1]);
75
+ }
76
+ }
77
+ }
78
+
79
+ return contractNames;
80
+ }
81
+
82
+ /** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
83
+ async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
84
+ const contractPackages = await getContractPackageNames();
85
+ if (contractPackages.size === 0) {
86
+ return;
87
+ }
88
+
89
+ let output: string;
90
+ try {
91
+ // We list tests for all the crates in the workspace
92
+ output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
93
+ encoding: 'utf-8',
94
+ stdio: ['pipe', 'pipe', 'inherit'],
95
+ });
96
+ } catch {
97
+ // If listing tests fails (e.g. test crate has compile errors), skip the check.
98
+ return;
99
+ }
100
+
101
+ // The output of the `nargo test --list-tests` command is as follows:
102
+ // ```
103
+ // crate_name_1 test_name_1
104
+ // crate_name_2 test_name_2
105
+ // ...
106
+ // crate_name_n test_name_n
107
+ // ```
108
+ //
109
+ // We parse the individual lines and then we check if any contract crate appeared in the parsed output.
110
+ const lines = output
111
+ .trim()
112
+ .split('\n')
113
+ .filter(line => line.length > 0);
114
+ const testsInContracts: { packageName: string; testName: string }[] = [];
115
+
116
+ for (const line of lines) {
117
+ const spaceIndex = line.indexOf(' ');
118
+ if (spaceIndex === -1) {
119
+ continue;
120
+ }
121
+ const packageName = line.substring(0, spaceIndex);
122
+ const testName = line.substring(spaceIndex + 1);
123
+ if (contractPackages.has(packageName)) {
124
+ testsInContracts.push({ packageName, testName });
125
+ }
126
+ }
127
+
128
+ if (testsInContracts.length > 0) {
129
+ const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
130
+ log(
131
+ `WARNING: Found tests in contract crate(s):\n${details}\n\n` +
132
+ `Tests should be in a dedicated test crate, not in the contract crate.\n` +
133
+ `Learn more: https://docs.aztec.network/errors/1`,
134
+ );
135
+ }
136
+ }
137
+
138
+ /** Compiles Aztec Noir contracts and postprocesses artifacts. */
139
+ async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
140
+ const nargo = process.env.NARGO ?? 'nargo';
141
+ const bb = process.env.BB ?? 'bb';
142
+
143
+ await run(nargo, ['compile', ...nargoArgs]);
144
+
145
+ // Ensure contract crates contain no tests (tests belong in the test crate).
146
+ await checkNoTestsInContracts(nargo, log);
147
+
148
+ const artifacts = await collectContractArtifacts();
149
+
150
+ if (artifacts.length > 0) {
151
+ log('Postprocessing contracts...');
152
+ const bbArgs = artifacts.flatMap(a => ['-i', a]);
153
+ await run(bb, ['aztec_process', ...bbArgs]);
154
+
155
+ // TODO: This should be part of bb aztec_process!
156
+ await stripInternalPrefixes(artifacts);
157
+ }
158
+
159
+ log('Compilation complete!');
160
+ }
161
+
162
+ export function injectCompileCommand(program: Command, log: LogFn): Command {
163
+ program
164
+ .command('compile')
165
+ .argument('[nargo-args...]')
166
+ .passThroughOptions()
167
+ .allowUnknownOption()
168
+ .description(
169
+ 'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
170
+ )
171
+ .addHelpText('after', () => {
172
+ // Show nargo's own compile options so users see all available flags in one place.
173
+ const nargo = process.env.NARGO ?? 'nargo';
174
+ try {
175
+ const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
176
+ return `\nUnderlying nargo compile options:\n\n${output}`;
177
+ } catch {
178
+ return '\n(Run "nargo compile --help" to see available nargo options)';
179
+ }
180
+ })
181
+ .action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
182
+
183
+ return program;
184
+ }