@aztec/aztec 0.0.1-commit.03f7ef2 → 0.0.1-commit.04852196a

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 (132) hide show
  1. package/dest/bin/index.js +9 -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 +55 -12
  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 +29 -11
  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 +165 -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/profile.d.ts +4 -0
  21. package/dest/cli/cmds/profile.d.ts.map +1 -0
  22. package/dest/cli/cmds/profile.js +8 -0
  23. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  24. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  25. package/dest/cli/cmds/profile_flamegraph.js +51 -0
  26. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  27. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  28. package/dest/cli/cmds/profile_gates.js +57 -0
  29. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  30. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  31. package/dest/cli/cmds/profile_utils.js +50 -0
  32. package/dest/cli/cmds/standby.d.ts +27 -0
  33. package/dest/cli/cmds/standby.d.ts.map +1 -0
  34. package/dest/cli/cmds/standby.js +78 -0
  35. package/dest/cli/cmds/start_archiver.d.ts +2 -2
  36. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_archiver.js +6 -8
  38. package/dest/cli/cmds/start_bot.d.ts +3 -3
  39. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  40. package/dest/cli/cmds/start_bot.js +9 -5
  41. package/dest/cli/cmds/start_node.d.ts +3 -2
  42. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  43. package/dest/cli/cmds/start_node.js +77 -27
  44. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  45. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  46. package/dest/cli/cmds/start_p2p_bootstrap.js +1 -2
  47. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  48. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  49. package/dest/cli/cmds/start_prover_agent.js +3 -3
  50. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  51. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  52. package/dest/cli/cmds/start_prover_broker.js +8 -8
  53. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  54. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  55. package/dest/cli/cmds/utils/artifacts.js +24 -0
  56. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  57. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  58. package/dest/cli/cmds/utils/needs_recompile.js +124 -0
  59. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  60. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  61. package/dest/cli/cmds/utils/spawn.js +16 -0
  62. package/dest/cli/util.d.ts +7 -18
  63. package/dest/cli/util.d.ts.map +1 -1
  64. package/dest/cli/util.js +51 -87
  65. package/dest/examples/token.js +9 -9
  66. package/dest/local-network/banana_fpc.d.ts +1 -1
  67. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  68. package/dest/local-network/banana_fpc.js +3 -3
  69. package/dest/local-network/local-network.d.ts +4 -3
  70. package/dest/local-network/local-network.d.ts.map +1 -1
  71. package/dest/local-network/local-network.js +69 -25
  72. package/dest/testing/anvil_test_watcher.d.ts +9 -1
  73. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  74. package/dest/testing/anvil_test_watcher.js +52 -15
  75. package/dest/testing/cheat_codes.d.ts +3 -1
  76. package/dest/testing/cheat_codes.d.ts.map +1 -1
  77. package/dest/testing/epoch_test_settler.d.ts +19 -0
  78. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  79. package/dest/testing/epoch_test_settler.js +62 -0
  80. package/dest/testing/index.d.ts +3 -1
  81. package/dest/testing/index.d.ts.map +1 -1
  82. package/dest/testing/index.js +2 -0
  83. package/dest/testing/token_allowed_setup.d.ts +7 -0
  84. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  85. package/dest/testing/token_allowed_setup.js +20 -0
  86. package/package.json +36 -34
  87. package/scripts/add_crate.sh +102 -0
  88. package/scripts/aztec.sh +22 -9
  89. package/scripts/init.sh +23 -19
  90. package/scripts/new.sh +48 -24
  91. package/scripts/setup_workspace.sh +68 -0
  92. package/src/bin/index.ts +9 -3
  93. package/src/cli/admin_api_key_store.ts +128 -0
  94. package/src/cli/aztec_start_action.ts +58 -7
  95. package/src/cli/aztec_start_options.ts +30 -9
  96. package/src/cli/cli.ts +4 -37
  97. package/src/cli/cmds/compile.ts +190 -0
  98. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  99. package/src/cli/cmds/profile.ts +25 -0
  100. package/src/cli/cmds/profile_flamegraph.ts +63 -0
  101. package/src/cli/cmds/profile_gates.ts +67 -0
  102. package/src/cli/cmds/profile_utils.ts +58 -0
  103. package/src/cli/cmds/standby.ts +111 -0
  104. package/src/cli/cmds/start_archiver.ts +3 -14
  105. package/src/cli/cmds/start_bot.ts +8 -5
  106. package/src/cli/cmds/start_node.ts +76 -33
  107. package/src/cli/cmds/start_p2p_bootstrap.ts +2 -2
  108. package/src/cli/cmds/start_prover_agent.ts +3 -11
  109. package/src/cli/cmds/start_prover_broker.ts +12 -15
  110. package/src/cli/cmds/utils/artifacts.ts +44 -0
  111. package/src/cli/cmds/utils/needs_recompile.ts +139 -0
  112. package/src/cli/cmds/utils/spawn.ts +16 -0
  113. package/src/cli/util.ts +58 -96
  114. package/src/examples/token.ts +10 -10
  115. package/src/local-network/banana_fpc.ts +11 -7
  116. package/src/local-network/local-network.ts +85 -30
  117. package/src/testing/anvil_test_watcher.ts +59 -15
  118. package/src/testing/epoch_test_settler.ts +71 -0
  119. package/src/testing/index.ts +2 -0
  120. package/src/testing/token_allowed_setup.ts +19 -0
  121. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  122. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  123. package/dest/cli/cmds/start_prover_node.js +0 -108
  124. package/dest/cli/release_version.d.ts +0 -2
  125. package/dest/cli/release_version.d.ts.map +0 -1
  126. package/dest/cli/release_version.js +0 -14
  127. package/scripts/compile.sh +0 -44
  128. package/scripts/extract_function.js +0 -47
  129. package/scripts/flamegraph.sh +0 -59
  130. package/scripts/setup_project.sh +0 -31
  131. package/src/cli/cmds/start_prover_node.ts +0 -124
  132. package/src/cli/release_version.ts +0 -21
package/scripts/new.sh CHANGED
@@ -1,59 +1,83 @@
1
1
  #!/usr/bin/env bash
2
2
  set -euo pipefail
3
3
 
4
- NARGO=${NARGO:-nargo}
5
4
  script_path=$(realpath $(dirname "$0"))
6
5
 
7
- type_arg="--contract"
6
+ project_path=""
8
7
 
9
8
  while [[ $# -gt 0 ]]; do
10
9
  case $1 in
11
10
  --help|-h)
12
11
  cat << 'EOF'
13
- Aztec New - Create a new Aztec Noir project in a new directory
12
+ Aztec New - Create a new Aztec Noir project or add a contract to an existing workspace
14
13
 
15
- Usage: aztec new [OPTIONS] <PATH>
14
+ Usage: aztec new <NAME>
16
15
 
17
16
  Arguments:
18
- <PATH> The path to save the new project
17
+ <NAME> The name for the new contract (also used as the directory name when
18
+ creating a new workspace)
19
19
 
20
20
  Options:
21
- --name <NAME> Name of the package [default: package directory name]
22
- --lib Create a library template instead of a contract
23
21
  -h, --help Print help
24
22
 
25
- This command creates a new Aztec Noir project using nargo and automatically
26
- adds the Aztec.nr dependency to your Nargo.toml file.
23
+ When run outside an existing workspace:
24
+ Creates a new directory with a workspace containing a contract crate and a
25
+ test crate, and automatically adds the Aztec.nr dependency to both.
26
+
27
+ When run inside an existing workspace (Nargo.toml with [workspace] exists):
28
+ Adds a new contract crate and test crate to the existing workspace.
27
29
  EOF
28
30
  exit 0
29
31
  ;;
30
- --lib)
31
- type_arg="--lib"
32
- shift
33
- ;;
34
- --name)
35
- name_arg="--name $2"
36
- shift 2
32
+ -*)
33
+ echo "Error: unknown option '$1'"
34
+ echo "Usage: aztec new <NAME>"
35
+ echo "Run 'aztec new --help' for more information"
36
+ exit 1
37
37
  ;;
38
38
  *)
39
+ if [ -n "$project_path" ]; then
40
+ echo "Error: unexpected argument '$1'"
41
+ echo "Usage: aztec new <NAME>"
42
+ echo "Run 'aztec new --help' for more information"
43
+ exit 1
44
+ fi
39
45
  project_path=$1
40
46
  shift
41
- break
42
47
  ;;
43
48
  esac
44
49
  done
45
50
 
46
51
  if [ -z "$project_path" ]; then
47
- echo "Error: PATH argument is required"
48
- echo "Usage: aztec new [OPTIONS] <PATH>"
52
+ echo "Error: NAME argument is required"
53
+ echo "Usage: aztec new <NAME>"
49
54
  echo "Run 'aztec new --help' for more information"
50
55
  exit 1
51
56
  fi
52
57
 
53
- echo "Creating new Noir project at $project_path..."
54
- $NARGO new $type_arg ${name_arg:-} $project_path
58
+ package_name="$(basename $project_path)"
59
+
60
+ # Validate that the name contains only valid Noir identifier characters
61
+ if ! [[ "$package_name" =~ ^[a-zA-Z][a-zA-Z0-9_]*$ ]]; then
62
+ echo "Error: '$package_name' is not a valid contract name"
63
+ echo "Name must start with a letter and contain only letters, digits, and underscores"
64
+ exit 1
65
+ fi
66
+
67
+ # Check if we're inside an existing workspace
68
+ if [ -f "Nargo.toml" ] && grep -q '\[workspace\]' Nargo.toml; then
69
+ # Add crate pair to existing workspace
70
+ echo "Adding contract '$package_name' to existing workspace..."
71
+ $script_path/add_crate.sh "$package_name"
72
+ else
73
+ # Create new workspace
74
+ if [ -d "$project_path" ] && [ "$(ls -A $project_path 2>/dev/null)" ]; then
75
+ echo "Error: $project_path already exists and is not empty"
76
+ exit 1
77
+ fi
55
78
 
56
- if [ "$type_arg" == "--contract" ]; then
57
- cd $project_path
58
- $script_path/setup_project.sh
79
+ echo "Creating new Aztec contract project at $project_path..."
80
+ mkdir -p "$project_path"
81
+ cd "$project_path"
82
+ $script_path/setup_workspace.sh "$package_name"
59
83
  fi
@@ -0,0 +1,68 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+
4
+ # Creates an Aztec contract workspace with a contract crate and a test crate.
5
+ # Usage: setup_workspace.sh <package_name>
6
+ # Must be called from the workspace root directory.
7
+
8
+ package_name=$1
9
+ script_path=$(realpath $(dirname "$0"))
10
+
11
+ if [ -z "$package_name" ]; then
12
+ echo "Error: package name is required"
13
+ exit 1
14
+ fi
15
+
16
+ if [ -f "Nargo.toml" ]; then
17
+ echo "Error: Nargo.toml already exists in the current directory."
18
+ echo "To add another contract crate to this workspace, use 'aztec new <name>' instead."
19
+ exit 1
20
+ fi
21
+
22
+ # Create workspace root Nargo.toml with empty members (add_crate.sh will populate)
23
+ cat > Nargo.toml << 'EOF'
24
+ [workspace]
25
+ members = []
26
+ EOF
27
+
28
+ # Create the first crate pair
29
+ $script_path/add_crate.sh "$package_name"
30
+
31
+ # Create README
32
+ cat > README.md << REOF
33
+ # ${package_name}
34
+
35
+ An Aztec Noir contract project.
36
+
37
+ ## Compile
38
+
39
+ \`\`\`bash
40
+ aztec compile
41
+ \`\`\`
42
+
43
+ This compiles all contract crates and outputs artifacts to \`target/\`.
44
+
45
+ ## Test
46
+
47
+ \`\`\`bash
48
+ aztec test
49
+ \`\`\`
50
+
51
+ This runs all tests in the workspace.
52
+
53
+ ## Generate TypeScript bindings
54
+
55
+ \`\`\`bash
56
+ aztec codegen target -o src/artifacts
57
+ \`\`\`
58
+
59
+ This generates TypeScript contract artifacts from the compiled output in \`target/\` into \`src/artifacts/\`.
60
+ REOF
61
+
62
+ # Create .gitignore
63
+ cat > .gitignore << 'GEOF'
64
+ target/
65
+ codegenCache.json
66
+ GEOF
67
+
68
+ echo "Created Aztec contract workspace with crates '${package_name}_contract' and '${package_name}_test'"
package/src/bin/index.ts CHANGED
@@ -11,11 +11,14 @@ import { injectCommands as injectMiscCommands } from '@aztec/cli/misc';
11
11
  import { injectCommands as injectValidatorKeysCommands } from '@aztec/cli/validator_keys';
12
12
  import { getActiveNetworkName } from '@aztec/foundation/config';
13
13
  import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
14
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
14
15
 
15
16
  import { Command } from 'commander';
16
17
 
18
+ import { injectCompileCommand } from '../cli/cmds/compile.js';
19
+ import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
20
+ import { injectProfileCommand } from '../cli/cmds/profile.js';
17
21
  import { injectAztecCommands } from '../cli/index.js';
18
- import { getCliVersion } from '../cli/release_version.js';
19
22
 
20
23
  const NETWORK_FLAG = 'network';
21
24
 
@@ -44,9 +47,9 @@ async function main() {
44
47
  await enrichEnvironmentWithNetworkConfig(networkName);
45
48
  enrichEnvironmentWithChainName(networkName);
46
49
 
47
- const cliVersion = getCliVersion();
50
+ const cliVersion = getPackageVersion() ?? 'unknown';
48
51
  let program = new Command('aztec');
49
- program.description('Aztec command line interface').version(cliVersion);
52
+ program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
50
53
  program = injectAztecCommands(program, userLog, debugLogger);
51
54
  program = injectBuilderCommands(program);
52
55
  program = injectContractCommands(program, userLog, debugLogger);
@@ -55,6 +58,9 @@ async function main() {
55
58
  program = injectAztecNodeCommands(program, userLog, debugLogger);
56
59
  program = injectMiscCommands(program, userLog);
57
60
  program = injectValidatorKeysCommands(program, userLog);
61
+ program = injectCompileCommand(program, userLog);
62
+ program = injectProfileCommand(program, userLog);
63
+ program = injectMigrateCommand(program, userLog);
58
64
 
59
65
  await program.parseAsync(process.argv);
60
66
  }
@@ -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
10
  import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
11
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
9
12
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
10
13
  import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
14
 
12
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
 
@@ -23,7 +26,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
23
26
  let config: ChainConfig | undefined = undefined;
24
27
 
25
28
  if (options.localNetwork) {
26
- const cliVersion = getCliVersion();
29
+ const cliVersion = getPackageVersion() ?? 'unknown';
27
30
  const localNetwork = extractNamespacedOptions(options, 'local-network');
28
31
  localNetwork.testAccounts = true;
29
32
  userLog(`${splash}\n${github}\n\n`);
@@ -35,6 +38,11 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
35
38
  l1RpcUrls: options.l1RpcUrls,
36
39
  testAccounts: localNetwork.testAccounts,
37
40
  realProofs: false,
41
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
42
+ // the users can consume out hash without having to wait for a long time.
43
+ // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
44
+ // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
45
+ aztecEpochDuration: 2,
38
46
  },
39
47
  userLog,
40
48
  );
@@ -43,15 +51,18 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
43
51
  signalHandlers.push(stop);
44
52
  services.node = [node, AztecNodeApiSchema];
45
53
  } else {
54
+ // Route --prover-node through startNode
55
+ if (options.proverNode && !options.node) {
56
+ options.node = true;
57
+ }
58
+
46
59
  if (options.node) {
47
60
  const { startNode } = await import('./cmds/start_node.js');
48
- ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
61
+ const networkName = getActiveNetworkName(options.network);
62
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
49
63
  } else if (options.bot) {
50
64
  const { startBot } = await import('./cmds/start_bot.js');
51
65
  await startBot(options, signalHandlers, services, userLog);
52
- } else if (options.proverNode) {
53
- const { startProverNode } = await import('./cmds/start_prover_node.js');
54
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
55
66
  } else if (options.archiver) {
56
67
  const { startArchiver } = await import('./cmds/start_archiver.js');
57
68
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -94,14 +105,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
94
105
 
95
106
  // If there are any admin services, start a separate JSON-RPC server for them
96
107
  if (Object.entries(adminServices).length > 0) {
108
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
109
+
110
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
111
+ const apiKeyResolution = await resolveAdminApiKey(
112
+ {
113
+ adminApiKeyHash: options.adminApiKeyHash,
114
+ disableAdminApiKey: options.disableAdminApiKey,
115
+ resetAdminApiKey: options.resetAdminApiKey,
116
+ dataDirectory: options.dataDirectory,
117
+ },
118
+ debugLogger,
119
+ );
120
+ if (apiKeyResolution) {
121
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
122
+ } else {
123
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
124
+ }
125
+
97
126
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
98
127
  http200OnError: false,
99
128
  log: debugLogger,
100
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
129
+ middlewares: adminMiddlewares,
101
130
  maxBatchSize: options.rpcMaxBatchSize,
102
131
  maxBodySizeBytes: options.rpcMaxBodySize,
103
132
  });
104
133
  const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
105
134
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
135
+
136
+ // Display the API key after the server has started
137
+ // Uses userLog which is never filtered by LOG_LEVEL.
138
+ if (apiKeyResolution?.rawKey) {
139
+ const separator = '='.repeat(70);
140
+ userLog('');
141
+ userLog(separator);
142
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
143
+ userLog('');
144
+ userLog(` ${apiKeyResolution.rawKey}`);
145
+ userLog('');
146
+ userLog(` Use via header: x-api-key: <key>`);
147
+ userLog(` Or via header: Authorization: Bearer <key>`);
148
+ if (options.dataDirectory) {
149
+ userLog('');
150
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
151
+ }
152
+ userLog('');
153
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
154
+ userLog(separator);
155
+ userLog('');
156
+ }
106
157
  }
107
158
  }
@@ -12,14 +12,14 @@ import {
12
12
  isBooleanConfigValue,
13
13
  omitConfigMappings,
14
14
  } from '@aztec/foundation/config';
15
- import { dataConfigMappings } from '@aztec/kv-store/config';
16
15
  import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
17
16
  import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
18
17
  import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
19
18
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
20
19
  import { allPxeConfigMappings } from '@aztec/pxe/config';
21
20
  import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
22
- import { chainConfigMappings } from '@aztec/stdlib/config';
21
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
22
+ import { dataConfigMappings } from '@aztec/stdlib/kv-store';
23
23
  import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
24
24
  import { worldStateConfigMappings } from '@aztec/world-state/config';
25
25
 
@@ -105,8 +105,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
105
105
  env: 'NETWORK',
106
106
  },
107
107
 
108
- configToFlag('--auto-update', sharedNodeConfigMappings.autoUpdate),
109
- configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
108
+ configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
110
109
 
111
110
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
112
111
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
@@ -142,12 +141,38 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
142
141
  env: 'AZTEC_ADMIN_PORT',
143
142
  parseVal: val => parseInt(val, 10),
144
143
  },
144
+ {
145
+ flag: '--admin-api-key-hash <value>',
146
+ description:
147
+ '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.',
148
+ defaultValue: undefined,
149
+ env: 'AZTEC_ADMIN_API_KEY_HASH',
150
+ },
151
+ {
152
+ flag: '--disable-admin-api-key',
153
+ description:
154
+ 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
155
+ defaultValue: false,
156
+ env: 'AZTEC_DISABLE_ADMIN_API_KEY',
157
+ // undefined means the flag was passed without a value (boolean toggle), treat as true.
158
+ parseVal: val => val === undefined || val === 'true' || val === '1',
159
+ },
160
+ {
161
+ flag: '--reset-admin-api-key',
162
+ description:
163
+ 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
164
+ defaultValue: false,
165
+ env: 'AZTEC_RESET_ADMIN_API_KEY',
166
+ parseVal: val => val === 'true' || val === '1',
167
+ },
145
168
  {
146
169
  flag: '--api-prefix <value>',
147
170
  description: 'Prefix for API routes on any service that is started',
148
171
  defaultValue: '',
149
172
  env: 'API_PREFIX',
150
173
  },
174
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
175
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
151
176
  ],
152
177
  ETHEREUM: [
153
178
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
@@ -168,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
168
193
  'WORLD STATE': [
169
194
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
170
195
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
171
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
196
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
172
197
  ],
173
198
  // We can't easily auto-generate node options as they're parts of modules defined below
174
199
  'AZTEC NODE': [
@@ -220,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
220
245
  'proverNode',
221
246
  omitConfigMappings(proverNodeConfigMappings, [
222
247
  // filter out options passed separately
223
- ...getKeys(archiverConfigMappings),
224
248
  ...getKeys(proverBrokerConfigMappings),
225
249
  ...getKeys(proverAgentConfigMappings),
226
- ...getKeys(p2pConfigMappings),
227
- ...getKeys(worldStateConfigMappings),
228
- ...getKeys(sharedNodeConfigMappings),
229
250
  ]),
230
251
  ),
231
252
  ],
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 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.
76
43
  `,
77
44
  );
78
45
  }