@aztec/aztec 0.0.1-commit.fce3e4f → 0.0.1-commit.ff7989d6c

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 (93) hide show
  1. package/dest/bin/index.js +8 -3
  2. package/dest/cli/admin_api_key_store.d.ts +45 -0
  3. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  4. package/dest/cli/admin_api_key_store.js +98 -0
  5. package/dest/cli/aztec_start_action.d.ts +1 -1
  6. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  7. package/dest/cli/aztec_start_action.js +50 -13
  8. package/dest/cli/aztec_start_options.d.ts +1 -1
  9. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  10. package/dest/cli/aztec_start_options.js +39 -33
  11. package/dest/cli/cli.d.ts +1 -1
  12. package/dest/cli/cli.d.ts.map +1 -1
  13. package/dest/cli/cli.js +4 -37
  14. package/dest/cli/cmds/compile.d.ts +4 -0
  15. package/dest/cli/cmds/compile.d.ts.map +1 -0
  16. package/dest/cli/cmds/compile.js +95 -0
  17. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  18. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  19. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  20. package/dest/cli/cmds/start_archiver.d.ts +1 -1
  21. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  22. package/dest/cli/cmds/start_archiver.js +11 -13
  23. package/dest/cli/cmds/start_bot.d.ts +3 -3
  24. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  25. package/dest/cli/cmds/start_bot.js +10 -6
  26. package/dest/cli/cmds/start_node.d.ts +1 -1
  27. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  28. package/dest/cli/cmds/start_node.js +64 -12
  29. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  30. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  31. package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
  32. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  33. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  34. package/dest/cli/cmds/start_prover_agent.js +4 -4
  35. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  36. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_prover_broker.js +4 -4
  38. package/dest/cli/util.d.ts +8 -17
  39. package/dest/cli/util.d.ts.map +1 -1
  40. package/dest/cli/util.js +13 -8
  41. package/dest/examples/token.js +5 -5
  42. package/dest/examples/util.d.ts +2 -2
  43. package/dest/examples/util.d.ts.map +1 -1
  44. package/dest/local-network/banana_fpc.d.ts +1 -1
  45. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  46. package/dest/local-network/banana_fpc.js +3 -3
  47. package/dest/local-network/local-network.d.ts +13 -14
  48. package/dest/local-network/local-network.d.ts.map +1 -1
  49. package/dest/local-network/local-network.js +68 -38
  50. package/dest/testing/anvil_test_watcher.d.ts +10 -2
  51. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  52. package/dest/testing/anvil_test_watcher.js +53 -16
  53. package/dest/testing/cheat_codes.d.ts +3 -1
  54. package/dest/testing/cheat_codes.d.ts.map +1 -1
  55. package/dest/testing/epoch_test_settler.d.ts +19 -0
  56. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  57. package/dest/testing/epoch_test_settler.js +62 -0
  58. package/dest/testing/index.d.ts +2 -1
  59. package/dest/testing/index.d.ts.map +1 -1
  60. package/dest/testing/index.js +1 -0
  61. package/package.json +37 -35
  62. package/scripts/aztec.sh +14 -8
  63. package/src/bin/index.ts +9 -3
  64. package/src/cli/admin_api_key_store.ts +128 -0
  65. package/src/cli/aztec_start_action.ts +53 -8
  66. package/src/cli/aztec_start_options.ts +40 -32
  67. package/src/cli/cli.ts +4 -37
  68. package/src/cli/cmds/compile.ts +107 -0
  69. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  70. package/src/cli/cmds/start_archiver.ts +7 -18
  71. package/src/cli/cmds/start_bot.ts +9 -6
  72. package/src/cli/cmds/start_node.ts +53 -11
  73. package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
  74. package/src/cli/cmds/start_prover_agent.ts +4 -12
  75. package/src/cli/cmds/start_prover_broker.ts +7 -3
  76. package/src/cli/util.ts +20 -25
  77. package/src/examples/token.ts +5 -7
  78. package/src/examples/util.ts +1 -1
  79. package/src/local-network/banana_fpc.ts +11 -7
  80. package/src/local-network/local-network.ts +107 -82
  81. package/src/testing/anvil_test_watcher.ts +61 -17
  82. package/src/testing/cheat_codes.ts +3 -2
  83. package/src/testing/epoch_test_settler.ts +71 -0
  84. package/src/testing/index.ts +1 -0
  85. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  86. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  87. package/dest/cli/cmds/start_blob_sink.js +0 -33
  88. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  89. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  90. package/dest/cli/cmds/start_prover_node.js +0 -108
  91. package/scripts/compile.sh +0 -44
  92. package/src/cli/cmds/start_blob_sink.ts +0 -57
  93. package/src/cli/cmds/start_prover_node.ts +0 -124
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aztec/aztec",
3
- "version": "0.0.1-commit.fce3e4f",
3
+ "version": "0.0.1-commit.ff7989d6c",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": "./dest/index.js",
@@ -15,12 +15,12 @@
15
15
  "tsconfig": "./tsconfig.json"
16
16
  },
17
17
  "scripts": {
18
- "build": "yarn clean && tsgo -b",
18
+ "build": "yarn clean && ../scripts/tsc.sh",
19
19
  "start": "node --no-warnings ./dest/bin",
20
20
  "start:debug": "node --inspect=0.0.0.0:9221 --no-warnings ./dest/bin",
21
21
  "start:local-network": "ETHEREUM_HOSTS=http://0.0.0.0:8545/ && yarn start start --local-network",
22
22
  "clean": "rm -rf ./dest .tsbuildinfo",
23
- "build:dev": "tsgo -b --watch",
23
+ "build:dev": "../scripts/tsc.sh --watch",
24
24
  "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}",
25
25
  "run:example:token": "LOG_LEVEL='verbose' node ./dest/examples/token.js"
26
26
  },
@@ -28,37 +28,39 @@
28
28
  "../package.common.json"
29
29
  ],
30
30
  "dependencies": {
31
- "@aztec/accounts": "0.0.1-commit.fce3e4f",
32
- "@aztec/archiver": "0.0.1-commit.fce3e4f",
33
- "@aztec/aztec-faucet": "0.0.1-commit.fce3e4f",
34
- "@aztec/aztec-node": "0.0.1-commit.fce3e4f",
35
- "@aztec/aztec.js": "0.0.1-commit.fce3e4f",
36
- "@aztec/bb-prover": "0.0.1-commit.fce3e4f",
37
- "@aztec/bb.js": "0.0.1-commit.fce3e4f",
38
- "@aztec/blob-sink": "0.0.1-commit.fce3e4f",
39
- "@aztec/bot": "0.0.1-commit.fce3e4f",
40
- "@aztec/builder": "0.0.1-commit.fce3e4f",
41
- "@aztec/cli": "0.0.1-commit.fce3e4f",
42
- "@aztec/constants": "0.0.1-commit.fce3e4f",
43
- "@aztec/entrypoints": "0.0.1-commit.fce3e4f",
44
- "@aztec/ethereum": "0.0.1-commit.fce3e4f",
45
- "@aztec/foundation": "0.0.1-commit.fce3e4f",
46
- "@aztec/kv-store": "0.0.1-commit.fce3e4f",
47
- "@aztec/l1-artifacts": "0.0.1-commit.fce3e4f",
48
- "@aztec/node-lib": "0.0.1-commit.fce3e4f",
49
- "@aztec/noir-contracts.js": "0.0.1-commit.fce3e4f",
50
- "@aztec/noir-protocol-circuits-types": "0.0.1-commit.fce3e4f",
51
- "@aztec/p2p": "0.0.1-commit.fce3e4f",
52
- "@aztec/p2p-bootstrap": "0.0.1-commit.fce3e4f",
53
- "@aztec/protocol-contracts": "0.0.1-commit.fce3e4f",
54
- "@aztec/prover-client": "0.0.1-commit.fce3e4f",
55
- "@aztec/prover-node": "0.0.1-commit.fce3e4f",
56
- "@aztec/pxe": "0.0.1-commit.fce3e4f",
57
- "@aztec/stdlib": "0.0.1-commit.fce3e4f",
58
- "@aztec/telemetry-client": "0.0.1-commit.fce3e4f",
59
- "@aztec/test-wallet": "0.0.1-commit.fce3e4f",
60
- "@aztec/txe": "0.0.1-commit.fce3e4f",
61
- "@aztec/world-state": "0.0.1-commit.fce3e4f",
31
+ "@aztec/accounts": "0.0.1-commit.ff7989d6c",
32
+ "@aztec/archiver": "0.0.1-commit.ff7989d6c",
33
+ "@aztec/aztec-faucet": "0.0.1-commit.ff7989d6c",
34
+ "@aztec/aztec-node": "0.0.1-commit.ff7989d6c",
35
+ "@aztec/aztec.js": "0.0.1-commit.ff7989d6c",
36
+ "@aztec/bb-prover": "0.0.1-commit.ff7989d6c",
37
+ "@aztec/bb.js": "0.0.1-commit.ff7989d6c",
38
+ "@aztec/blob-client": "0.0.1-commit.ff7989d6c",
39
+ "@aztec/bot": "0.0.1-commit.ff7989d6c",
40
+ "@aztec/builder": "0.0.1-commit.ff7989d6c",
41
+ "@aztec/cli": "0.0.1-commit.ff7989d6c",
42
+ "@aztec/constants": "0.0.1-commit.ff7989d6c",
43
+ "@aztec/entrypoints": "0.0.1-commit.ff7989d6c",
44
+ "@aztec/ethereum": "0.0.1-commit.ff7989d6c",
45
+ "@aztec/foundation": "0.0.1-commit.ff7989d6c",
46
+ "@aztec/kv-store": "0.0.1-commit.ff7989d6c",
47
+ "@aztec/l1-artifacts": "0.0.1-commit.ff7989d6c",
48
+ "@aztec/node-lib": "0.0.1-commit.ff7989d6c",
49
+ "@aztec/noir-contracts.js": "0.0.1-commit.ff7989d6c",
50
+ "@aztec/noir-protocol-circuits-types": "0.0.1-commit.ff7989d6c",
51
+ "@aztec/p2p": "0.0.1-commit.ff7989d6c",
52
+ "@aztec/p2p-bootstrap": "0.0.1-commit.ff7989d6c",
53
+ "@aztec/protocol-contracts": "0.0.1-commit.ff7989d6c",
54
+ "@aztec/prover-client": "0.0.1-commit.ff7989d6c",
55
+ "@aztec/prover-node": "0.0.1-commit.ff7989d6c",
56
+ "@aztec/pxe": "0.0.1-commit.ff7989d6c",
57
+ "@aztec/sequencer-client": "0.0.1-commit.ff7989d6c",
58
+ "@aztec/stdlib": "0.0.1-commit.ff7989d6c",
59
+ "@aztec/telemetry-client": "0.0.1-commit.ff7989d6c",
60
+ "@aztec/txe": "0.0.1-commit.ff7989d6c",
61
+ "@aztec/validator-ha-signer": "0.0.1-commit.ff7989d6c",
62
+ "@aztec/wallets": "0.0.1-commit.ff7989d6c",
63
+ "@aztec/world-state": "0.0.1-commit.ff7989d6c",
62
64
  "@types/chalk": "^2.2.0",
63
65
  "abitype": "^0.8.11",
64
66
  "chalk": "^5.3.0",
@@ -78,7 +80,7 @@
78
80
  "@jest/globals": "^30.0.0",
79
81
  "@types/jest": "^30.0.0",
80
82
  "@types/koa": "^2.15.0",
81
- "@typescript/native-preview": "7.0.0-dev.20251126.1",
83
+ "@typescript/native-preview": "7.0.0-dev.20260113.1",
82
84
  "jest": "^30.0.0",
83
85
  "ts-node": "^10.9.1",
84
86
  "typescript": "^5.3.3"
package/scripts/aztec.sh CHANGED
@@ -1,26 +1,32 @@
1
1
  #!/usr/bin/env bash
2
2
  set -euo pipefail
3
3
 
4
+ # Re-execute using correct version if we have an .aztecrc file.
5
+ if [ "${AZTEC_VERSIONED:-0}" -eq 0 ] && [ -f .aztecrc ] && command -v aztec-up &>/dev/null; then
6
+ env_setup=$(aztec-up env)
7
+ eval "$env_setup"
8
+ AZTEC_VERSIONED=1 exec aztec "$@"
9
+ fi
10
+
11
+ cmd=${1:-}
12
+ [ -n "$cmd" ] && shift
13
+
4
14
  script_dir="$(dirname "$(realpath "$0")")"
5
15
 
6
16
  function aztec {
17
+ export AZTEC_SHELL_WRAPPER=1
7
18
  exec node --no-warnings $script_dir/../dest/bin/index.js "$@"
8
19
  }
9
20
 
10
- cmd=${1:-}
11
- [ -n "$cmd" ] && shift
12
-
13
- export AZTEC_SHELL_WRAPPER=1
14
-
15
21
  case $cmd in
16
22
  test)
17
- export LOG_LEVEL="${LOG_LEVEL:-info}"
23
+ export LOG_LEVEL="${LOG_LEVEL:-"error;trace:contract_log"}"
18
24
  aztec start --txe --port 8081 &
19
25
  server_pid=$!
20
26
  trap 'kill $server_pid &>/dev/null || true' EXIT
21
27
  while ! nc -z 127.0.0.1 8081 &>/dev/null; do sleep 0.2; done
22
28
  export NARGO_FOREIGN_CALL_TIMEOUT=300000
23
- nargo test --silence-warnings --pedantic-solving --oracle-resolver http://127.0.0.1:8081 "$@"
29
+ nargo test --silence-warnings --oracle-resolver http://127.0.0.1:8081 --test-threads 16 "$@"
24
30
  ;;
25
31
  start)
26
32
  if [ "${1:-}" == "--local-network" ]; then
@@ -47,7 +53,7 @@ case $cmd in
47
53
 
48
54
  aztec start "$@"
49
55
  ;;
50
- compile|new|init|flamegraph)
56
+ new|init|flamegraph)
51
57
  $script_dir/${cmd}.sh "$@"
52
58
  ;;
53
59
  *)
package/src/bin/index.ts CHANGED
@@ -2,7 +2,8 @@
2
2
  //
3
3
  import { injectCommands as injectBuilderCommands } from '@aztec/builder';
4
4
  import { injectCommands as injectAztecNodeCommands } from '@aztec/cli/aztec_node';
5
- import { enrichEnvironmentWithChainName, enrichEnvironmentWithNetworkConfig } from '@aztec/cli/config';
5
+ import { enrichEnvironmentWithChainName } from '@aztec/cli/config/chain';
6
+ import { enrichEnvironmentWithNetworkConfig } from '@aztec/cli/config/network';
6
7
  import { injectCommands as injectContractCommands } from '@aztec/cli/contracts';
7
8
  import { injectCommands as injectInfrastructureCommands } from '@aztec/cli/infrastructure';
8
9
  import { injectCommands as injectL1Commands } from '@aztec/cli/l1';
@@ -13,10 +14,13 @@ import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
13
14
 
14
15
  import { Command } from 'commander';
15
16
 
16
- import { NETWORK_FLAG } from '../cli/aztec_start_options.js';
17
+ import { injectCompileCommand } from '../cli/cmds/compile.js';
18
+ import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
17
19
  import { injectAztecCommands } from '../cli/index.js';
18
20
  import { getCliVersion } from '../cli/release_version.js';
19
21
 
22
+ const NETWORK_FLAG = 'network';
23
+
20
24
  const userLog = createConsoleLogger();
21
25
  const debugLogger = createLogger('cli');
22
26
 
@@ -44,7 +48,7 @@ async function main() {
44
48
 
45
49
  const cliVersion = getCliVersion();
46
50
  let program = new Command('aztec');
47
- program.description('Aztec command line interface').version(cliVersion);
51
+ program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
48
52
  program = injectAztecCommands(program, userLog, debugLogger);
49
53
  program = injectBuilderCommands(program);
50
54
  program = injectContractCommands(program, userLog, debugLogger);
@@ -53,6 +57,8 @@ async function main() {
53
57
  program = injectAztecNodeCommands(program, userLog, debugLogger);
54
58
  program = injectMiscCommands(program, userLog);
55
59
  program = injectValidatorKeysCommands(program, userLog);
60
+ program = injectCompileCommand(program, userLog);
61
+ program = injectMigrateCommand(program, userLog);
56
62
 
57
63
  await program.parseAsync(process.argv);
58
64
  }
@@ -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';
@@ -11,6 +12,7 @@ import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
12
 
12
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';
@@ -33,9 +35,13 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
33
35
  {
34
36
  l1Mnemonic: localNetwork.l1Mnemonic,
35
37
  l1RpcUrls: options.l1RpcUrls,
36
- deployAztecContractsSalt: localNetwork.deployAztecContractsSalt,
37
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
 
@@ -124,14 +126,6 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
124
126
  defaultValue: DefaultMnemonic,
125
127
  env: 'MNEMONIC',
126
128
  },
127
- {
128
- flag: '--local-network.deployAztecContractsSalt <value>',
129
- description:
130
- 'Numeric salt for deploying L1 Aztec contracts before starting the local network. Needs mnemonic or private key to be set.',
131
- env: 'DEPLOY_AZTEC_CONTRACTS_SALT',
132
- defaultValue: undefined,
133
- parseVal: (val: string) => (val ? parseInt(val) : undefined),
134
- },
135
129
  ],
136
130
  API: [
137
131
  {
@@ -148,20 +142,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
148
142
  env: 'AZTEC_ADMIN_PORT',
149
143
  parseVal: val => parseInt(val, 10),
150
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
+ },
151
169
  {
152
170
  flag: '--api-prefix <value>',
153
171
  description: 'Prefix for API routes on any service that is started',
154
172
  defaultValue: '',
155
173
  env: 'API_PREFIX',
156
174
  },
175
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
176
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
157
177
  ],
158
178
  ETHEREUM: [
159
179
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
160
180
  // Do not set default for CLI: keep undefined unless provided via flag or env
161
181
  configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
162
- configToFlag('--l1-consensus-host-urls', blobSinkConfigMappings.l1ConsensusHostUrls),
163
- configToFlag('--l1-consensus-host-api-keys', blobSinkConfigMappings.l1ConsensusHostApiKeys),
164
- 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),
165
185
  ],
166
186
  'L1 CONTRACTS': [
167
187
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -174,7 +194,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
174
194
  'WORLD STATE': [
175
195
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
176
196
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
177
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
197
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
178
198
  ],
179
199
  // We can't easily auto-generate node options as they're parts of modules defined below
180
200
  'AZTEC NODE': [
@@ -208,21 +228,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
208
228
  'sequencer',
209
229
  omitConfigMappings(sequencerClientConfigMappings, [
210
230
  'fakeProcessingDelayPerTxMs',
231
+ 'fakeThrowAfterProcessingTxCount',
211
232
  'skipCollectingAttestations',
212
233
  'skipInvalidateBlockAsProposer',
213
234
  'blobSinkMapSizeKb',
214
235
  ]),
215
236
  ),
216
237
  ],
217
- 'BLOB SINK': [
218
- {
219
- flag: '--blob-sink',
220
- description: 'Starts Aztec Blob Sink with options',
221
- defaultValue: undefined,
222
- env: undefined,
223
- },
224
- ...getOptions('blobSink', blobSinkConfigMappings),
225
- ],
226
238
  'PROVER NODE': [
227
239
  {
228
240
  flag: '--prover-node',
@@ -234,12 +246,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
234
246
  'proverNode',
235
247
  omitConfigMappings(proverNodeConfigMappings, [
236
248
  // filter out options passed separately
237
- ...getKeys(archiverConfigMappings),
238
249
  ...getKeys(proverBrokerConfigMappings),
239
250
  ...getKeys(proverAgentConfigMappings),
240
- ...getKeys(p2pConfigMappings),
241
- ...getKeys(worldStateConfigMappings),
242
- ...getKeys(sharedNodeConfigMappings),
243
251
  ]),
244
252
  ),
245
253
  ],
package/src/cli/cli.ts CHANGED
@@ -35,44 +35,11 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
35
35
  program.addHelpText(
36
36
  'after',
37
37
  `
38
+ Additional commands:
38
39
 
39
- Additional commands:
40
-
41
- init [folder] [options]: creates a new Noir project
42
- Options:
43
- --name <name> Name of the package
44
- --contract Use a contract template (default)
45
- --lib Use a library template
46
- --bin Use a binary template
47
- Examples:
48
- $ aztec init # creates a contract project in current directory
49
- $ aztec init --lib # creates a library project
50
-
51
- new <path> [options]: creates a new Noir project in a new directory
52
- Options:
53
- --name <name> Name of the package
54
- --contract Use a contract template (default)
55
- --lib Use a library template
56
- --bin Use a binary template
57
- Examples:
58
- $ aztec new my-project # creates a contract project in ./my-project
59
- $ aztec new my-lib --lib # creates a library project in ./my-lib
60
-
61
- compile [options]: compiles Aztec Noir contracts
62
- Compiles contracts with nargo compile and then postprocesses them to generate Aztec-specific artifacts including:
63
- - Transpiled contract artifacts
64
- - Verification keys
65
- The compiled contracts will be placed in the target/ directory by default.
66
- Supports standard nargo compile options.
67
-
68
- test [options]: starts a dockerized TXE node via
69
- $ aztec start --txe
70
- then runs
71
- $ aztec test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
72
-
73
- preload-crs: Downloads and caches the Common Reference String (CRS) data required for zero-knowledge proofs.
74
- Example:
75
- $ aztec preload-crs # preloads CRS data
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.
76
43
  `,
77
44
  );
78
45
  }