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

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 (190) hide show
  1. package/README.md +1 -1
  2. package/dest/bin/index.d.ts +1 -1
  3. package/dest/bin/index.js +13 -6
  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 +90 -31
  10. package/dest/cli/aztec_start_options.d.ts +2 -2
  11. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  12. package/dest/cli/aztec_start_options.js +60 -53
  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 +166 -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 +52 -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 +76 -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/standby.d.ts +30 -0
  34. package/dest/cli/cmds/standby.d.ts.map +1 -0
  35. package/dest/cli/cmds/standby.js +97 -0
  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 +13 -9
  39. package/dest/cli/cmds/start_node.d.ts +3 -2
  40. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  41. package/dest/cli/cmds/start_node.js +79 -39
  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 +8 -20
  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 +25 -16
  51. package/dest/cli/cmds/start_txe.d.ts +2 -2
  52. package/dest/cli/cmds/start_txe.d.ts.map +1 -1
  53. package/dest/cli/cmds/start_txe.js +6 -5
  54. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  55. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  56. package/dest/cli/cmds/utils/artifacts.js +24 -0
  57. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts +21 -0
  58. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
  59. package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
  60. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  61. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  62. package/dest/cli/cmds/utils/needs_recompile.js +90 -0
  63. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  64. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  65. package/dest/cli/cmds/utils/spawn.js +16 -0
  66. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
  67. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
  68. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +61 -0
  69. package/dest/cli/index.d.ts +1 -1
  70. package/dest/cli/preload_crs.d.ts +1 -1
  71. package/dest/cli/util.d.ts +12 -23
  72. package/dest/cli/util.d.ts.map +1 -1
  73. package/dest/cli/util.js +57 -91
  74. package/dest/cli/versioning.d.ts +1 -1
  75. package/dest/examples/token.d.ts +1 -1
  76. package/dest/examples/token.js +10 -10
  77. package/dest/examples/util.d.ts +2 -2
  78. package/dest/examples/util.d.ts.map +1 -1
  79. package/dest/index.d.ts +2 -2
  80. package/dest/index.d.ts.map +1 -1
  81. package/dest/index.js +1 -1
  82. package/dest/local-network/auth_registry.d.ts +5 -0
  83. package/dest/local-network/auth_registry.d.ts.map +1 -0
  84. package/dest/local-network/auth_registry.js +17 -0
  85. package/dest/local-network/banana_fpc.d.ts +11 -0
  86. package/dest/local-network/banana_fpc.d.ts.map +1 -0
  87. package/dest/{sandbox → local-network}/banana_fpc.js +14 -10
  88. package/dest/local-network/index.d.ts +4 -0
  89. package/dest/local-network/index.d.ts.map +1 -0
  90. package/dest/{sandbox → local-network}/index.js +1 -1
  91. package/dest/local-network/local-network.d.ts +50 -0
  92. package/dest/local-network/local-network.d.ts.map +1 -0
  93. package/dest/local-network/local-network.js +248 -0
  94. package/dest/local-network/sponsored_fpc.d.ts +5 -0
  95. package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
  96. package/dest/mnemonic.d.ts +1 -1
  97. package/dest/splash.d.ts +1 -1
  98. package/dest/testing/anvil_test_watcher.d.ts +26 -6
  99. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  100. package/dest/testing/anvil_test_watcher.js +128 -35
  101. package/dest/testing/cheat_codes.d.ts +18 -17
  102. package/dest/testing/cheat_codes.d.ts.map +1 -1
  103. package/dest/testing/cheat_codes.js +72 -36
  104. package/dest/testing/epoch_test_settler.d.ts +19 -0
  105. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  106. package/dest/testing/epoch_test_settler.js +63 -0
  107. package/dest/testing/index.d.ts +4 -2
  108. package/dest/testing/index.d.ts.map +1 -1
  109. package/dest/testing/index.js +2 -0
  110. package/dest/testing/token_allowed_setup.d.ts +7 -0
  111. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  112. package/dest/testing/token_allowed_setup.js +20 -0
  113. package/package.json +42 -37
  114. package/scripts/add_crate.sh +53 -0
  115. package/scripts/aztec.sh +73 -0
  116. package/scripts/init.sh +39 -0
  117. package/scripts/new.sh +83 -0
  118. package/scripts/setup_workspace.sh +69 -0
  119. package/scripts/templates/blank/contract/Nargo.toml +6 -0
  120. package/scripts/templates/blank/contract/src/main.nr +10 -0
  121. package/scripts/templates/blank/test/Nargo.toml +7 -0
  122. package/scripts/templates/blank/test/src/lib.nr +11 -0
  123. package/scripts/templates/counter/contract/Nargo.toml +7 -0
  124. package/scripts/templates/counter/contract/src/main.nr +48 -0
  125. package/scripts/templates/counter/test/Nargo.toml +7 -0
  126. package/scripts/templates/counter/test/src/lib.nr +32 -0
  127. package/src/bin/index.ts +14 -6
  128. package/src/cli/admin_api_key_store.ts +128 -0
  129. package/src/cli/aztec_start_action.ts +83 -26
  130. package/src/cli/aztec_start_options.ts +68 -59
  131. package/src/cli/cli.ts +11 -11
  132. package/src/cli/cmds/compile.ts +192 -0
  133. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  134. package/src/cli/cmds/profile.ts +26 -0
  135. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  136. package/src/cli/cmds/profile_gates.ts +84 -0
  137. package/src/cli/cmds/profile_utils.ts +58 -0
  138. package/src/cli/cmds/standby.ts +132 -0
  139. package/src/cli/cmds/start_bot.ts +12 -11
  140. package/src/cli/cmds/start_node.ts +90 -44
  141. package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
  142. package/src/cli/cmds/start_prover_agent.ts +9 -20
  143. package/src/cli/cmds/start_prover_broker.ts +29 -26
  144. package/src/cli/cmds/start_txe.ts +7 -5
  145. package/src/cli/cmds/utils/artifacts.ts +44 -0
  146. package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
  147. package/src/cli/cmds/utils/needs_recompile.ts +98 -0
  148. package/src/cli/cmds/utils/spawn.ts +16 -0
  149. package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +76 -0
  150. package/src/cli/util.ts +66 -104
  151. package/src/examples/token.ts +11 -11
  152. package/src/examples/util.ts +1 -1
  153. package/src/index.ts +2 -2
  154. package/src/local-network/auth_registry.ts +19 -0
  155. package/src/{sandbox → local-network}/banana_fpc.ts +17 -9
  156. package/src/{sandbox → local-network}/index.ts +1 -1
  157. package/src/local-network/local-network.ts +303 -0
  158. package/src/{sandbox → local-network}/sponsored_fpc.ts +3 -2
  159. package/src/testing/anvil_test_watcher.ts +142 -33
  160. package/src/testing/cheat_codes.ts +92 -38
  161. package/src/testing/epoch_test_settler.ts +69 -0
  162. package/src/testing/index.ts +3 -1
  163. package/src/testing/token_allowed_setup.ts +19 -0
  164. package/dest/cli/cmds/start_archiver.d.ts +0 -9
  165. package/dest/cli/cmds/start_archiver.d.ts.map +0 -1
  166. package/dest/cli/cmds/start_archiver.js +0 -50
  167. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  168. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  169. package/dest/cli/cmds/start_blob_sink.js +0 -33
  170. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  171. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  172. package/dest/cli/cmds/start_prover_node.js +0 -108
  173. package/dest/cli/release_version.d.ts +0 -2
  174. package/dest/cli/release_version.d.ts.map +0 -1
  175. package/dest/cli/release_version.js +0 -14
  176. package/dest/sandbox/banana_fpc.d.ts +0 -10
  177. package/dest/sandbox/banana_fpc.d.ts.map +0 -1
  178. package/dest/sandbox/index.d.ts +0 -4
  179. package/dest/sandbox/index.d.ts.map +0 -1
  180. package/dest/sandbox/sandbox.d.ts +0 -74
  181. package/dest/sandbox/sandbox.d.ts.map +0 -1
  182. package/dest/sandbox/sandbox.js +0 -183
  183. package/dest/sandbox/sponsored_fpc.d.ts +0 -4
  184. package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
  185. package/src/cli/cmds/start_archiver.ts +0 -61
  186. package/src/cli/cmds/start_blob_sink.ts +0 -57
  187. package/src/cli/cmds/start_prover_node.ts +0 -124
  188. package/src/cli/release_version.ts +0 -21
  189. package/src/sandbox/sandbox.ts +0 -242
  190. /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,17 +1,20 @@
1
+ import { getActiveNetworkName } from '@aztec/foundation/config';
1
2
  import {
2
3
  type NamespacedApiHandlers,
3
4
  createNamespacedSafeJsonRpcServer,
5
+ getApiKeyAuthMiddleware,
4
6
  startHttpRpcServer,
5
7
  } from '@aztec/foundation/json-rpc/server';
6
8
  import type { LogFn, Logger } from '@aztec/foundation/log';
7
9
  import type { ChainConfig } from '@aztec/stdlib/config';
8
- import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
10
+ import { AztecNodeAdminApiSchema, AztecNodeApiSchema, AztecNodeDebugApiSchema } from '@aztec/stdlib/interfaces/client';
11
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
9
12
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
10
- import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
13
+ import { getOtelJsonRpcDiagnosticsMiddleware, getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
14
 
12
- import { createSandbox } from '../sandbox/index.js';
15
+ import { createLocalNetwork } from '../local-network/index.js';
13
16
  import { github, splash } from '../splash.js';
14
- import { getCliVersion } from './release_version.js';
17
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
15
18
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
16
19
  import { getVersions } from './versioning.js';
17
20
 
@@ -20,22 +23,25 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
20
23
  const signalHandlers: Array<() => Promise<void>> = [];
21
24
  const services: NamespacedApiHandlers = {};
22
25
  const adminServices: NamespacedApiHandlers = {};
26
+ const packageVersion = getPackageVersion();
23
27
  let config: ChainConfig | undefined = undefined;
24
28
 
25
- if (options.sandbox) {
26
- const cliVersion = getCliVersion();
27
- const sandboxOptions = extractNamespacedOptions(options, 'sandbox');
28
- sandboxOptions.testAccounts = true;
29
+ if (options.localNetwork) {
30
+ const localNetwork = extractNamespacedOptions(options, 'localNetwork');
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 ${packageVersion}, 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
  );
@@ -43,22 +49,24 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
43
49
  // Start Node and PXE JSON-RPC server
44
50
  signalHandlers.push(stop);
45
51
  services.node = [node, AztecNodeApiSchema];
52
+ adminServices.node = [node, AztecNodeAdminApiSchema];
53
+ services.nodeDebug = [node, AztecNodeDebugApiSchema];
46
54
  } else {
55
+ // Route --prover-node through startNode
56
+ if (options.proverNode && !options.node) {
57
+ options.node = true;
58
+ }
59
+
47
60
  if (options.node) {
48
61
  const { startNode } = await import('./cmds/start_node.js');
49
- ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
62
+ const networkName = getActiveNetworkName(options.network);
63
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
64
+ if (options.nodeDebug && services.node) {
65
+ services.nodeDebug = [services.node[0], AztecNodeDebugApiSchema];
66
+ }
50
67
  } else if (options.bot) {
51
68
  const { startBot } = await import('./cmds/start_bot.js');
52
69
  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
- } else if (options.archiver) {
60
- const { startArchiver } = await import('./cmds/start_archiver.js');
61
- ({ config } = await startArchiver(options, signalHandlers, services));
62
70
  } else if (options.p2pBootstrap) {
63
71
  const { startP2PBootstrap } = await import('./cmds/start_p2p_bootstrap.js');
64
72
  ({ config } = await startP2PBootstrap(options, signalHandlers, services, userLog));
@@ -70,7 +78,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
70
78
  await startProverBroker(options, signalHandlers, services, userLog);
71
79
  } else if (options.txe) {
72
80
  const { startTXE } = await import('./cmds/start_txe.js');
73
- await startTXE(options, debugLogger);
81
+ await startTXE(options, signalHandlers, debugLogger);
74
82
  } else if (options.sequencer) {
75
83
  userLog(`Cannot run a standalone sequencer without a node`);
76
84
  process.exit(1);
@@ -82,13 +90,21 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
82
90
 
83
91
  installSignalHandlers(debugLogger.info, signalHandlers);
84
92
  const versions = getVersions(config);
93
+ const versioningOpts = { packageVersion };
85
94
 
86
95
  // Start the main JSON-RPC server
87
96
  if (Object.entries(services).length > 0) {
97
+ if (services.node) {
98
+ const { BarretenbergSync } = await import('@aztec/bb.js');
99
+ // JSON-RPC schema parsing may decompress compressed Chonk proofs before the node handler runs.
100
+ await BarretenbergSync.initSingleton();
101
+ }
102
+
88
103
  const rpcServer = createNamespacedSafeJsonRpcServer(services, {
104
+ diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
89
105
  http200OnError: false,
90
106
  log: debugLogger,
91
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
107
+ middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
92
108
  maxBatchSize: options.rpcMaxBatchSize,
93
109
  maxBodySizeBytes: options.rpcMaxBodySize,
94
110
  });
@@ -98,14 +114,55 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
98
114
 
99
115
  // If there are any admin services, start a separate JSON-RPC server for them
100
116
  if (Object.entries(adminServices).length > 0) {
117
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
118
+
119
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
120
+ const apiKeyResolution = await resolveAdminApiKey(
121
+ {
122
+ adminApiKeyHash: options.adminApiKeyHash,
123
+ disableAdminApiKey: options.disableAdminApiKey,
124
+ resetAdminApiKey: options.resetAdminApiKey,
125
+ dataDirectory: options.dataDirectory,
126
+ },
127
+ debugLogger,
128
+ );
129
+ if (apiKeyResolution) {
130
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
131
+ } else {
132
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
133
+ }
134
+
101
135
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
136
+ diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
102
137
  http200OnError: false,
103
138
  log: debugLogger,
104
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
139
+ middlewares: adminMiddlewares,
105
140
  maxBatchSize: options.rpcMaxBatchSize,
106
141
  maxBodySizeBytes: options.rpcMaxBodySize,
107
142
  });
108
143
  const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
109
144
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
145
+
146
+ // Display the API key after the server has started
147
+ // Uses userLog which is never filtered by LOG_LEVEL.
148
+ if (apiKeyResolution?.rawKey) {
149
+ const separator = '='.repeat(70);
150
+ userLog('');
151
+ userLog(separator);
152
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
153
+ userLog('');
154
+ userLog(` ${apiKeyResolution.rawKey}`);
155
+ userLog('');
156
+ userLog(` Use via header: x-api-key: <key>`);
157
+ userLog(` Or via header: Authorization: Bearer <key>`);
158
+ if (options.dataDirectory) {
159
+ userLog('');
160
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
161
+ }
162
+ userLog('');
163
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
164
+ userLog(separator);
165
+ userLog('');
166
+ }
110
167
  }
111
168
  }
@@ -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,
@@ -11,15 +12,16 @@ import {
11
12
  isBooleanConfigValue,
12
13
  omitConfigMappings,
13
14
  } from '@aztec/foundation/config';
14
- import { dataConfigMappings } from '@aztec/kv-store/config';
15
15
  import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
16
16
  import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
17
- import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
17
+ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
18
18
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
19
19
  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';
20
+ import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
21
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
22
+ import { dataConfigMappings } from '@aztec/stdlib/kv-store';
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
 
@@ -34,7 +36,7 @@ export interface AztecStartOption {
34
36
  parseVal?: (val: string) => any;
35
37
  }
36
38
 
37
- export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping>) => {
39
+ export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => {
38
40
  const options: AztecStartOption[] = [];
39
41
  for (const [key, { env, defaultValue: def, parseEnv, description, printDefault, fallback }] of Object.entries(
40
42
  configMappings,
@@ -56,7 +58,11 @@ export const getOptions = (namespace: string, configMappings: Record<string, Con
56
58
  return options;
57
59
  };
58
60
 
59
- const configToFlag = (flag: string, configMapping: ConfigMapping, overrideDefaultValue?: any): AztecStartOption => {
61
+ const configToFlag = (
62
+ flag: string,
63
+ configMapping: ConfigMapping<unknown>,
64
+ overrideDefaultValue?: any,
65
+ ): AztecStartOption => {
60
66
  if (!configMapping.isBoolean) {
61
67
  flag += ' <value>';
62
68
  }
@@ -82,6 +88,7 @@ export const universalOptions = [
82
88
  'l1ConsensusHostApiKeys',
83
89
  'l1ConsensusHostApiKeyHeaders',
84
90
  'p2pEnabled',
91
+ 'fishermanMode',
85
92
  ...getKeys(chainConfigMappings),
86
93
  ...getKeys(l1ContractsConfigMappings),
87
94
  ...getKeys(l1ContractAddressesMapping),
@@ -102,32 +109,31 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
102
109
  env: 'NETWORK',
103
110
  },
104
111
 
105
- configToFlag('--auto-update', sharedNodeConfigMappings.autoUpdate),
106
- configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
112
+ configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
107
113
 
108
114
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
109
115
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
116
+
117
+ configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode),
110
118
  ],
111
- SANDBOX: [
119
+ LOCAL_NETWORK: [
112
120
  {
113
- flag: '--sandbox',
114
- description: 'Starts Aztec Sandbox',
121
+ flag: '--local-network',
122
+ description: 'Starts Aztec Local Network',
115
123
  defaultValue: undefined,
116
124
  env: undefined,
117
125
  },
118
126
  {
119
- flag: '--sandbox.l1Mnemonic <value>',
127
+ flag: '--local-network.l1Mnemonic <value>',
120
128
  description: 'Mnemonic for L1 accounts. Will be used ',
121
129
  defaultValue: DefaultMnemonic,
122
130
  env: 'MNEMONIC',
123
131
  },
124
132
  {
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),
133
+ flag: '--local-network.testAccounts',
134
+ description: 'Deploy test accounts on local network start',
135
+ env: 'TEST_ACCOUNTS',
136
+ ...booleanConfigHelper(true),
131
137
  },
132
138
  ],
133
139
  API: [
@@ -145,20 +151,53 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
145
151
  env: 'AZTEC_ADMIN_PORT',
146
152
  parseVal: val => parseInt(val, 10),
147
153
  },
154
+ {
155
+ flag: '--admin-api-key-hash <value>',
156
+ description:
157
+ '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.',
158
+ defaultValue: undefined,
159
+ env: 'AZTEC_ADMIN_API_KEY_HASH',
160
+ },
161
+ {
162
+ flag: '--disable-admin-api-key',
163
+ description:
164
+ 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
165
+ defaultValue: false,
166
+ env: 'AZTEC_DISABLE_ADMIN_API_KEY',
167
+ // undefined means the flag was passed without a value (boolean toggle), treat as true.
168
+ parseVal: val => val === undefined || val === 'true' || val === '1',
169
+ },
170
+ {
171
+ flag: '--reset-admin-api-key',
172
+ description:
173
+ 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
174
+ defaultValue: false,
175
+ env: 'AZTEC_RESET_ADMIN_API_KEY',
176
+ parseVal: val => val === 'true' || val === '1',
177
+ },
178
+ {
179
+ flag: '--node-debug',
180
+ description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
181
+ defaultValue: false,
182
+ env: 'AZTEC_NODE_DEBUG',
183
+ parseVal: val => val === undefined || val === 'true' || val === '1',
184
+ },
148
185
  {
149
186
  flag: '--api-prefix <value>',
150
187
  description: 'Prefix for API routes on any service that is started',
151
188
  defaultValue: '',
152
189
  env: 'API_PREFIX',
153
190
  },
191
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
192
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
154
193
  ],
155
194
  ETHEREUM: [
156
195
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
157
196
  // Do not set default for CLI: keep undefined unless provided via flag or env
158
197
  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),
198
+ configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
199
+ configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
200
+ configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
162
201
  ],
163
202
  'L1 CONTRACTS': [
164
203
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -171,7 +210,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
171
210
  'WORLD STATE': [
172
211
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
173
212
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
174
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
213
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
175
214
  ],
176
215
  // We can't easily auto-generate node options as they're parts of modules defined below
177
216
  'AZTEC NODE': [
@@ -183,12 +222,6 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
183
222
  },
184
223
  ],
185
224
  ARCHIVER: [
186
- {
187
- flag: '--archiver',
188
- description: 'Starts Aztec Archiver with options',
189
- defaultValue: undefined,
190
- env: undefined,
191
- },
192
225
  ...getOptions(
193
226
  'archiver',
194
227
  omitConfigMappings(archiverConfigMappings, Object.keys(l1ContractsConfigMappings) as (keyof ArchiverConfig)[]),
@@ -205,21 +238,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
205
238
  'sequencer',
206
239
  omitConfigMappings(sequencerClientConfigMappings, [
207
240
  'fakeProcessingDelayPerTxMs',
241
+ 'fakeThrowAfterProcessingTxCount',
208
242
  'skipCollectingAttestations',
209
243
  'skipInvalidateBlockAsProposer',
210
244
  'blobSinkMapSizeKb',
211
245
  ]),
212
246
  ),
213
247
  ],
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
248
  'PROVER NODE': [
224
249
  {
225
250
  flag: '--prover-node',
@@ -231,12 +256,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
231
256
  'proverNode',
232
257
  omitConfigMappings(proverNodeConfigMappings, [
233
258
  // filter out options passed separately
234
- ...getKeys(archiverConfigMappings),
235
259
  ...getKeys(proverBrokerConfigMappings),
236
260
  ...getKeys(proverAgentConfigMappings),
237
- ...getKeys(p2pConfigMappings),
238
- ...getKeys(worldStateConfigMappings),
239
- ...getKeys(sharedNodeConfigMappings),
240
261
  ]),
241
262
  ),
242
263
  ],
@@ -247,11 +268,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
247
268
  defaultValue: undefined,
248
269
  env: undefined,
249
270
  },
250
- ...getOptions(
251
- 'proverBroker',
252
- // filter out archiver options from prover node options as they're passed separately in --archiver
253
- proverBrokerConfigMappings,
254
- ),
271
+ ...getOptions('proverBroker', proverBrokerConfigMappings),
255
272
  ],
256
273
  'PROVER AGENT': [
257
274
  {
@@ -299,15 +316,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
299
316
  },
300
317
  ...getOptions('bot', botConfigMappings),
301
318
  ],
302
- PXE: [
303
- {
304
- flag: '--pxe',
305
- description: 'Starts Aztec PXE with options',
306
- defaultValue: undefined,
307
- env: undefined,
308
- },
309
- ...getOptions('pxe', allPxeConfigMappings),
310
- ],
319
+ PXE: [...getOptions('pxe', allPxeConfigMappings)],
311
320
  TXE: [
312
321
  {
313
322
  flag: '--txe',
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 creates a new Aztec Noir workspace in the current directory.
41
+ 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).
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')