@aztec/aztec 0.0.1-commit.f146247c → 0.0.1-commit.f1b29a41e

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 (128) hide show
  1. package/dest/bin/index.js +7 -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 +61 -16
  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 +25 -9
  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 +3 -4
  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 +168 -0
  17. package/dest/cli/cmds/profile.d.ts +4 -0
  18. package/dest/cli/cmds/profile.d.ts.map +1 -0
  19. package/dest/cli/cmds/profile.js +8 -0
  20. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  21. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  22. package/dest/cli/cmds/profile_flamegraph.js +52 -0
  23. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  24. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  25. package/dest/cli/cmds/profile_gates.js +58 -0
  26. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  27. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  28. package/dest/cli/cmds/profile_utils.js +50 -0
  29. package/dest/cli/cmds/standby.d.ts +32 -0
  30. package/dest/cli/cmds/standby.d.ts.map +1 -0
  31. package/dest/cli/cmds/standby.js +97 -0
  32. package/dest/cli/cmds/start_archiver.d.ts +2 -2
  33. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  34. package/dest/cli/cmds/start_archiver.js +1 -1
  35. package/dest/cli/cmds/start_bot.d.ts +3 -3
  36. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_bot.js +9 -5
  38. package/dest/cli/cmds/start_node.d.ts +3 -2
  39. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  40. package/dest/cli/cmds/start_node.js +83 -27
  41. package/dest/cli/cmds/start_prover_agent.js +2 -2
  42. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  43. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  44. package/dest/cli/cmds/start_prover_broker.js +14 -8
  45. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  46. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  47. package/dest/cli/cmds/utils/artifacts.js +24 -0
  48. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts +21 -0
  49. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
  50. package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
  51. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  52. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  53. package/dest/cli/cmds/utils/needs_recompile.js +90 -0
  54. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  55. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  56. package/dest/cli/cmds/utils/spawn.js +16 -0
  57. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
  58. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
  59. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +41 -0
  60. package/dest/cli/util.d.ts +7 -18
  61. package/dest/cli/util.d.ts.map +1 -1
  62. package/dest/cli/util.js +50 -86
  63. package/dest/examples/token.js +6 -6
  64. package/dest/local-network/banana_fpc.js +1 -1
  65. package/dest/local-network/local-network.d.ts +4 -2
  66. package/dest/local-network/local-network.d.ts.map +1 -1
  67. package/dest/local-network/local-network.js +50 -18
  68. package/dest/testing/anvil_test_watcher.d.ts +9 -1
  69. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  70. package/dest/testing/anvil_test_watcher.js +53 -16
  71. package/dest/testing/cheat_codes.js +1 -1
  72. package/dest/testing/epoch_test_settler.d.ts +1 -1
  73. package/dest/testing/epoch_test_settler.d.ts.map +1 -1
  74. package/dest/testing/epoch_test_settler.js +3 -4
  75. package/dest/testing/index.d.ts +2 -1
  76. package/dest/testing/index.d.ts.map +1 -1
  77. package/dest/testing/index.js +1 -0
  78. package/dest/testing/token_allowed_setup.d.ts +7 -0
  79. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  80. package/dest/testing/token_allowed_setup.js +20 -0
  81. package/package.json +34 -34
  82. package/scripts/add_crate.sh +102 -0
  83. package/scripts/aztec.sh +11 -5
  84. package/scripts/init.sh +23 -19
  85. package/scripts/new.sh +48 -24
  86. package/scripts/setup_workspace.sh +68 -0
  87. package/src/bin/index.ts +7 -3
  88. package/src/cli/admin_api_key_store.ts +128 -0
  89. package/src/cli/aztec_start_action.ts +60 -12
  90. package/src/cli/aztec_start_options.ts +27 -8
  91. package/src/cli/cli.ts +3 -4
  92. package/src/cli/cmds/compile.ts +194 -0
  93. package/src/cli/cmds/profile.ts +25 -0
  94. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  95. package/src/cli/cmds/profile_gates.ts +68 -0
  96. package/src/cli/cmds/profile_utils.ts +58 -0
  97. package/src/cli/cmds/standby.ts +132 -0
  98. package/src/cli/cmds/start_archiver.ts +1 -1
  99. package/src/cli/cmds/start_bot.ts +8 -5
  100. package/src/cli/cmds/start_node.ts +83 -33
  101. package/src/cli/cmds/start_prover_agent.ts +2 -2
  102. package/src/cli/cmds/start_prover_broker.ts +19 -15
  103. package/src/cli/cmds/utils/artifacts.ts +44 -0
  104. package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
  105. package/src/cli/cmds/utils/needs_recompile.ts +98 -0
  106. package/src/cli/cmds/utils/spawn.ts +16 -0
  107. package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +54 -0
  108. package/src/cli/util.ts +57 -95
  109. package/src/examples/token.ts +8 -6
  110. package/src/local-network/banana_fpc.ts +1 -1
  111. package/src/local-network/local-network.ts +54 -17
  112. package/src/testing/anvil_test_watcher.ts +60 -16
  113. package/src/testing/cheat_codes.ts +1 -1
  114. package/src/testing/epoch_test_settler.ts +3 -4
  115. package/src/testing/index.ts +1 -0
  116. package/src/testing/token_allowed_setup.ts +19 -0
  117. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  118. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  119. package/dest/cli/cmds/start_prover_node.js +0 -108
  120. package/dest/cli/release_version.d.ts +0 -2
  121. package/dest/cli/release_version.d.ts.map +0 -1
  122. package/dest/cli/release_version.js +0 -14
  123. package/scripts/compile.sh +0 -44
  124. package/scripts/extract_function.js +0 -47
  125. package/scripts/flamegraph.sh +0 -59
  126. package/scripts/setup_project.sh +0 -31
  127. package/src/cli/cmds/start_prover_node.ts +0 -124
  128. package/src/cli/release_version.ts +0 -21
package/dest/bin/index.js CHANGED
@@ -11,10 +11,12 @@ 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
  import { Command } from 'commander';
16
+ import { injectCompileCommand } from '../cli/cmds/compile.js';
15
17
  import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
18
+ import { injectProfileCommand } from '../cli/cmds/profile.js';
16
19
  import { injectAztecCommands } from '../cli/index.js';
17
- import { getCliVersion } from '../cli/release_version.js';
18
20
  const NETWORK_FLAG = 'network';
19
21
  const userLog = createConsoleLogger();
20
22
  const debugLogger = createLogger('cli');
@@ -34,9 +36,9 @@ const debugLogger = createLogger('cli');
34
36
  const networkName = getActiveNetworkName(networkValue);
35
37
  await enrichEnvironmentWithNetworkConfig(networkName);
36
38
  enrichEnvironmentWithChainName(networkName);
37
- const cliVersion = getCliVersion();
39
+ const cliVersion = getPackageVersion() ?? 'unknown';
38
40
  let program = new Command('aztec');
39
- program.description('Aztec command line interface').version(cliVersion);
41
+ program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
40
42
  program = injectAztecCommands(program, userLog, debugLogger);
41
43
  program = injectBuilderCommands(program);
42
44
  program = injectContractCommands(program, userLog, debugLogger);
@@ -45,6 +47,8 @@ const debugLogger = createLogger('cli');
45
47
  program = injectAztecNodeCommands(program, userLog, debugLogger);
46
48
  program = injectMiscCommands(program, userLog);
47
49
  program = injectValidatorKeysCommands(program, userLog);
50
+ program = injectCompileCommand(program, userLog);
51
+ program = injectProfileCommand(program, userLog);
48
52
  program = injectMigrateCommand(program, userLog);
49
53
  await program.parseAsync(process.argv);
50
54
  }
@@ -0,0 +1,45 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+ /**
3
+ * Result of resolving the admin API key.
4
+ * Contains the SHA-256 hex hash of the API key to be used by the auth middleware,
5
+ * and optionally the raw key when newly generated (so the caller can display it).
6
+ */
7
+ export interface AdminApiKeyResolution {
8
+ /** The SHA-256 hash of the API key. */
9
+ apiKeyHash: Buffer;
10
+ /**
11
+ * The raw API key, only present when a new key was generated during this call.
12
+ * The caller MUST display this to the operator — it will not be stored or returned again.
13
+ */
14
+ rawKey?: string;
15
+ }
16
+ export interface ResolveAdminApiKeyOptions {
17
+ /** SHA-256 hex hash of a pre-generated API key. When set, the node uses this hash directly. */
18
+ adminApiKeyHash?: string;
19
+ /** If true, disable admin API key auth entirely. */
20
+ disableAdminApiKey?: boolean;
21
+ /** If true, force-generate a new key even if one is already persisted. */
22
+ resetAdminApiKey?: boolean;
23
+ /** Root data directory for persistent storage. */
24
+ dataDirectory?: string;
25
+ }
26
+ /**
27
+ * Resolves the admin API key for the admin RPC endpoint.
28
+ *
29
+ * Strategy:
30
+ * 1. If opt-out flag is set (`disableAdminApiKey`), return undefined (no auth).
31
+ * 2. If a pre-generated hash is provided (`adminApiKeyHash`), use it directly.
32
+ * 3. If a data directory exists, look for a persisted hash file
33
+ * at `<dataDirectory>/admin/api_key_hash`:
34
+ * - If `resetAdminApiKey` is set, skip loading and force-generate a new key.
35
+ * - Found: use the stored hash (operator already saved the key from first run).
36
+ * - Not found: auto-generate a random key, display it once, persist the hash.
37
+ * 3. If no data directory: generate a random key
38
+ * each run and display it (cannot persist).
39
+ *
40
+ * @param options - The options for resolving the admin API key.
41
+ * @param log - Logger for outputting the key and status messages.
42
+ * @returns The resolved API key hash, or undefined if auth is disabled.
43
+ */
44
+ export declare function resolveAdminApiKey(options: ResolveAdminApiKeyOptions, log: Logger): Promise<AdminApiKeyResolution | undefined>;
45
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWRtaW5fYXBpX2tleV9zdG9yZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9hZG1pbl9hcGlfa2V5X3N0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBU3BEOzs7O0dBSUc7QUFDSCxNQUFNLFdBQVcscUJBQXFCO0lBQ3BDLHVDQUF1QztJQUN2QyxVQUFVLEVBQUUsTUFBTSxDQUFDO0lBQ25COzs7T0FHRztJQUNILE1BQU0sQ0FBQyxFQUFFLE1BQU0sQ0FBQztDQUNqQjtBQUVELE1BQU0sV0FBVyx5QkFBeUI7SUFDeEMsK0ZBQStGO0lBQy9GLGVBQWUsQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUN6QixvREFBb0Q7SUFDcEQsa0JBQWtCLENBQUMsRUFBRSxPQUFPLENBQUM7SUFDN0IsMEVBQTBFO0lBQzFFLGdCQUFnQixDQUFDLEVBQUUsT0FBTyxDQUFDO0lBQzNCLGtEQUFrRDtJQUNsRCxhQUFhLENBQUMsRUFBRSxNQUFNLENBQUM7Q0FDeEI7QUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FpQkc7QUFDSCx3QkFBc0Isa0JBQWtCLENBQ3RDLE9BQU8sRUFBRSx5QkFBeUIsRUFDbEMsR0FBRyxFQUFFLE1BQU0sR0FDVixPQUFPLENBQUMscUJBQXFCLEdBQUcsU0FBUyxDQUFDLENBMkQ1QyJ9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"admin_api_key_store.d.ts","sourceRoot":"","sources":["../../src/cli/admin_api_key_store.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AASpD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,+FAA+F;IAC/F,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,yBAAyB,EAClC,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CA2D5C"}
@@ -0,0 +1,98 @@
1
+ import { randomBytes } from '@aztec/foundation/crypto/random';
2
+ import { sha256Hash } from '@aztec/foundation/json-rpc/server';
3
+ import { promises as fs } from 'fs';
4
+ import { join } from 'path';
5
+ /** Subdirectory under dataDirectory for admin API key storage. */ const ADMIN_STORE_DIR = 'admin';
6
+ const HASH_FILE_NAME = 'api_key_hash';
7
+ /**
8
+ * Resolves the admin API key for the admin RPC endpoint.
9
+ *
10
+ * Strategy:
11
+ * 1. If opt-out flag is set (`disableAdminApiKey`), return undefined (no auth).
12
+ * 2. If a pre-generated hash is provided (`adminApiKeyHash`), use it directly.
13
+ * 3. If a data directory exists, look for a persisted hash file
14
+ * at `<dataDirectory>/admin/api_key_hash`:
15
+ * - If `resetAdminApiKey` is set, skip loading and force-generate a new key.
16
+ * - Found: use the stored hash (operator already saved the key from first run).
17
+ * - Not found: auto-generate a random key, display it once, persist the hash.
18
+ * 3. If no data directory: generate a random key
19
+ * each run and display it (cannot persist).
20
+ *
21
+ * @param options - The options for resolving the admin API key.
22
+ * @param log - Logger for outputting the key and status messages.
23
+ * @returns The resolved API key hash, or undefined if auth is disabled.
24
+ */ export async function resolveAdminApiKey(options, log) {
25
+ // Operator explicitly opted out of admin auth
26
+ if (options.disableAdminApiKey) {
27
+ log.warn('Admin API key authentication is DISABLED (--disable-admin-api-key / AZTEC_DISABLE_ADMIN_API_KEY)');
28
+ return undefined;
29
+ }
30
+ // Operator provided a pre-generated hash (e.g. via AZTEC_ADMIN_API_KEY_HASH env var)
31
+ if (options.adminApiKeyHash) {
32
+ const hex = options.adminApiKeyHash.trim();
33
+ if (hex.length !== 64 || !/^[0-9a-f]{64}$/.test(hex)) {
34
+ throw new Error(`Invalid admin API key hash: expected 64-char hex string, got "${hex}"`);
35
+ }
36
+ log.info('Admin API key authentication enabled (using pre-configured key hash)');
37
+ return {
38
+ apiKeyHash: Buffer.from(hex, 'hex')
39
+ };
40
+ }
41
+ // Persistent storage available, load or generate key
42
+ if (options.dataDirectory) {
43
+ const adminDir = join(options.dataDirectory, ADMIN_STORE_DIR);
44
+ const hashFilePath = join(adminDir, HASH_FILE_NAME);
45
+ // Unless a reset is forced, try to load the existing hash from disk
46
+ if (!options.resetAdminApiKey) {
47
+ try {
48
+ const storedHash = (await fs.readFile(hashFilePath, 'utf-8')).trim();
49
+ if (storedHash.length === 64) {
50
+ log.info('Admin API key authentication enabled (loaded stored key hash from disk)');
51
+ return {
52
+ apiKeyHash: Buffer.from(storedHash, 'hex')
53
+ };
54
+ }
55
+ log.warn(`Invalid stored admin API key hash at ${hashFilePath}, regenerating...`);
56
+ } catch (err) {
57
+ if (err.code !== 'ENOENT') {
58
+ log.warn(`Failed to read admin API key hash from ${hashFilePath}: ${err.message}`);
59
+ }
60
+ // File doesn't exist — fall through to generate
61
+ }
62
+ } else {
63
+ log.warn('Admin API key reset requested — generating a new key');
64
+ }
65
+ // Generate a new key, persist the hash, and return the raw key for the caller to display
66
+ const { rawKey, hash } = generateApiKey();
67
+ await fs.mkdir(adminDir, {
68
+ recursive: true
69
+ });
70
+ await fs.writeFile(hashFilePath, hash.toString('hex'), 'utf-8');
71
+ // Set restrictive permissions (owner read/write only)
72
+ await fs.chmod(hashFilePath, 0o600);
73
+ log.info('Admin API key authentication enabled (new key generated and hash persisted to disk)');
74
+ return {
75
+ apiKeyHash: hash,
76
+ rawKey
77
+ };
78
+ }
79
+ // No data directory, generate a temporary key per session
80
+ const { rawKey, hash } = generateApiKey();
81
+ log.warn('No data directory configured — admin API key cannot be persisted.');
82
+ log.warn('A temporary key has been generated for this session only.');
83
+ return {
84
+ apiKeyHash: hash,
85
+ rawKey
86
+ };
87
+ }
88
+ /**
89
+ * Generates a cryptographically random API key and its SHA-256 hash.
90
+ * @returns The raw key (hex string) and its SHA-256 hash as a Buffer.
91
+ */ function generateApiKey() {
92
+ const rawKey = randomBytes(32).toString('hex');
93
+ const hash = sha256Hash(rawKey);
94
+ return {
95
+ rawKey,
96
+ hash
97
+ };
98
+ }
@@ -1,3 +1,3 @@
1
1
  import type { LogFn, Logger } from '@aztec/foundation/log';
2
2
  export declare function aztecStart(options: any, userLog: LogFn, debugLogger: Logger): Promise<void>;
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFLQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFZM0Qsd0JBQXNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUJBOEZqRiJ9
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFPQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFhM0Qsd0JBQXNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUJBMklqRiJ9
@@ -1 +1 @@
1
- {"version":3,"file":"aztec_start_action.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_action.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAY3D,wBAAsB,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iBA8FjF"}
1
+ {"version":3,"file":"aztec_start_action.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_action.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAa3D,wBAAsB,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iBA2IjF"}
@@ -1,10 +1,12 @@
1
- import { createNamespacedSafeJsonRpcServer, startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
2
- import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
1
+ import { getActiveNetworkName } from '@aztec/foundation/config';
2
+ import { createNamespacedSafeJsonRpcServer, getApiKeyAuthMiddleware, startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
3
+ import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
4
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
3
5
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
4
6
  import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
5
7
  import { createLocalNetwork } from '../local-network/index.js';
6
8
  import { github, splash } from '../splash.js';
7
- import { getCliVersion } from './release_version.js';
9
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
8
10
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
9
11
  import { getVersions } from './versioning.js';
10
12
  export async function aztecStart(options, userLog, debugLogger) {
@@ -12,23 +14,23 @@ export async function aztecStart(options, userLog, debugLogger) {
12
14
  const signalHandlers = [];
13
15
  const services = {};
14
16
  const adminServices = {};
17
+ const packageVersion = getPackageVersion();
15
18
  let config = undefined;
16
19
  if (options.localNetwork) {
17
- const cliVersion = getCliVersion();
18
20
  const localNetwork = extractNamespacedOptions(options, 'local-network');
19
21
  localNetwork.testAccounts = true;
20
22
  userLog(`${splash}\n${github}\n\n`);
21
- userLog(`Setting up Aztec local network ${cliVersion}, please stand by...`);
23
+ userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
22
24
  const { node, stop } = await createLocalNetwork({
23
25
  l1Mnemonic: localNetwork.l1Mnemonic,
24
26
  l1RpcUrls: options.l1RpcUrls,
25
27
  testAccounts: localNetwork.testAccounts,
26
28
  realProofs: false,
27
- // Setting the epoch duration to 4 by default for local network. This allows the epoch to be "proven" faster, so
29
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
28
30
  // the users can consume out hash without having to wait for a long time.
29
31
  // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
30
32
  // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
31
- aztecEpochDuration: 4
33
+ aztecEpochDuration: 2
32
34
  }, userLog);
33
35
  // Start Node and PXE JSON-RPC server
34
36
  signalHandlers.push(stop);
@@ -36,16 +38,22 @@ export async function aztecStart(options, userLog, debugLogger) {
36
38
  node,
37
39
  AztecNodeApiSchema
38
40
  ];
41
+ adminServices.node = [
42
+ node,
43
+ AztecNodeAdminApiSchema
44
+ ];
39
45
  } else {
46
+ // Route --prover-node through startNode
47
+ if (options.proverNode && !options.node) {
48
+ options.node = true;
49
+ }
40
50
  if (options.node) {
41
51
  const { startNode } = await import('./cmds/start_node.js');
42
- ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
52
+ const networkName = getActiveNetworkName(options.network);
53
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
43
54
  } else if (options.bot) {
44
55
  const { startBot } = await import('./cmds/start_bot.js');
45
56
  await startBot(options, signalHandlers, services, userLog);
46
- } else if (options.proverNode) {
47
- const { startProverNode } = await import('./cmds/start_prover_node.js');
48
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
49
57
  } else if (options.archiver) {
50
58
  const { startArchiver } = await import('./cmds/start_archiver.js');
51
59
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -71,6 +79,9 @@ export async function aztecStart(options, userLog, debugLogger) {
71
79
  }
72
80
  installSignalHandlers(debugLogger.info, signalHandlers);
73
81
  const versions = getVersions(config);
82
+ const versioningOpts = {
83
+ packageVersion
84
+ };
74
85
  // Start the main JSON-RPC server
75
86
  if (Object.entries(services).length > 0) {
76
87
  const rpcServer = createNamespacedSafeJsonRpcServer(services, {
@@ -78,7 +89,7 @@ export async function aztecStart(options, userLog, debugLogger) {
78
89
  log: debugLogger,
79
90
  middlewares: [
80
91
  getOtelJsonRpcPropagationMiddleware(),
81
- getVersioningMiddleware(versions)
92
+ getVersioningMiddleware(versions, versioningOpts)
82
93
  ],
83
94
  maxBatchSize: options.rpcMaxBatchSize,
84
95
  maxBodySizeBytes: options.rpcMaxBodySize
@@ -90,13 +101,26 @@ export async function aztecStart(options, userLog, debugLogger) {
90
101
  }
91
102
  // If there are any admin services, start a separate JSON-RPC server for them
92
103
  if (Object.entries(adminServices).length > 0) {
104
+ const adminMiddlewares = [
105
+ getOtelJsonRpcPropagationMiddleware(),
106
+ getVersioningMiddleware(versions, versioningOpts)
107
+ ];
108
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
109
+ const apiKeyResolution = await resolveAdminApiKey({
110
+ adminApiKeyHash: options.adminApiKeyHash,
111
+ disableAdminApiKey: options.disableAdminApiKey,
112
+ resetAdminApiKey: options.resetAdminApiKey,
113
+ dataDirectory: options.dataDirectory
114
+ }, debugLogger);
115
+ if (apiKeyResolution) {
116
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
117
+ } else {
118
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
119
+ }
93
120
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
94
121
  http200OnError: false,
95
122
  log: debugLogger,
96
- middlewares: [
97
- getOtelJsonRpcPropagationMiddleware(),
98
- getVersioningMiddleware(versions)
99
- ],
123
+ middlewares: adminMiddlewares,
100
124
  maxBatchSize: options.rpcMaxBatchSize,
101
125
  maxBodySizeBytes: options.rpcMaxBodySize
102
126
  });
@@ -104,5 +128,26 @@ export async function aztecStart(options, userLog, debugLogger) {
104
128
  port: options.adminPort
105
129
  });
106
130
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
131
+ // Display the API key after the server has started
132
+ // Uses userLog which is never filtered by LOG_LEVEL.
133
+ if (apiKeyResolution?.rawKey) {
134
+ const separator = '='.repeat(70);
135
+ userLog('');
136
+ userLog(separator);
137
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
138
+ userLog('');
139
+ userLog(` ${apiKeyResolution.rawKey}`);
140
+ userLog('');
141
+ userLog(` Use via header: x-api-key: <key>`);
142
+ userLog(` Or via header: Authorization: Bearer <key>`);
143
+ if (options.dataDirectory) {
144
+ userLog('');
145
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
146
+ }
147
+ userLog('');
148
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
149
+ userLog(separator);
150
+ userLog('');
151
+ }
107
152
  }
108
153
  }
@@ -14,4 +14,4 @@ export declare const NETWORK_FLAG = "network";
14
14
  export declare const aztecStartOptions: {
15
15
  [key: string]: AztecStartOption[];
16
16
  };
17
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfb3B0aW9ucy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9henRlY19zdGFydF9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFDTCxLQUFLLGFBQWEsRUFDbEIsS0FBSyxNQUFNLEVBSVosTUFBTSwwQkFBMEIsQ0FBQztBQWVsQyxNQUFNLFdBQVcsZ0JBQWdCO0lBQy9CLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYixXQUFXLEVBQUUsTUFBTSxDQUFDO0lBQ3BCLFlBQVksRUFBRSxHQUFHLENBQUM7SUFDbEIsWUFBWSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLE1BQU0sQ0FBQztJQUNwQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUN4QixRQUFRLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNwQixRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssR0FBRyxDQUFDO0NBQ2pDO0FBRUQsZUFBTyxNQUFNLFVBQVUsMEZBb0J0QixDQUFDO0FBdUJGLGVBQU8sTUFBTSxnQkFBZ0IsVUFZNUIsQ0FBQztBQUVGLGVBQU8sTUFBTSxZQUFZLFlBQVksQ0FBQztBQUd0QyxlQUFPLE1BQU0saUJBQWlCLEVBQUU7SUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQTtDQW1ObEUsQ0FBQyJ9
17
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfb3B0aW9ucy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9henRlY19zdGFydF9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFDTCxLQUFLLGFBQWEsRUFDbEIsS0FBSyxNQUFNLEVBSVosTUFBTSwwQkFBMEIsQ0FBQztBQWVsQyxNQUFNLFdBQVcsZ0JBQWdCO0lBQy9CLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYixXQUFXLEVBQUUsTUFBTSxDQUFDO0lBQ3BCLFlBQVksRUFBRSxHQUFHLENBQUM7SUFDbEIsWUFBWSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLE1BQU0sQ0FBQztJQUNwQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUN4QixRQUFRLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNwQixRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssR0FBRyxDQUFDO0NBQ2pDO0FBRUQsZUFBTyxNQUFNLFVBQVUsMEZBb0J0QixDQUFDO0FBdUJGLGVBQU8sTUFBTSxnQkFBZ0IsVUFZNUIsQ0FBQztBQUVGLGVBQU8sTUFBTSxZQUFZLFlBQVksQ0FBQztBQUd0QyxlQUFPLE1BQU0saUJBQWlCLEVBQUU7SUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQTtDQXNPbEUsQ0FBQyJ9
@@ -1 +1 @@
1
- {"version":3,"file":"aztec_start_options.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_options.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,MAAM,EAIZ,MAAM,0BAA0B,CAAC;AAelC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,CAAC;IACpC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC;CACjC;AAED,eAAO,MAAM,UAAU,0FAoBtB,CAAC;AAuBF,eAAO,MAAM,gBAAgB,UAY5B,CAAC;AAEF,eAAO,MAAM,YAAY,YAAY,CAAC;AAGtC,eAAO,MAAM,iBAAiB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAA;CAmNlE,CAAC"}
1
+ {"version":3,"file":"aztec_start_options.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_options.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,MAAM,EAIZ,MAAM,0BAA0B,CAAC;AAelC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,CAAC;IACpC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC;CACjC;AAED,eAAO,MAAM,UAAU,0FAoBtB,CAAC;AAuBF,eAAO,MAAM,gBAAgB,UAY5B,CAAC;AAEF,eAAO,MAAM,YAAY,YAAY,CAAC;AAGtC,eAAO,MAAM,iBAAiB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAA;CAsOlE,CAAC"}
@@ -6,7 +6,6 @@ import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresse
6
6
  import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
7
7
  import { getKeys } from '@aztec/foundation/collection';
8
8
  import { booleanConfigHelper, isBooleanConfigValue, omitConfigMappings } from '@aztec/foundation/config';
9
- import { dataConfigMappings } from '@aztec/kv-store/config';
10
9
  import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
11
10
  import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
12
11
  import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
@@ -14,6 +13,7 @@ import { proverNodeConfigMappings } from '@aztec/prover-node/config';
14
13
  import { allPxeConfigMappings } from '@aztec/pxe/config';
15
14
  import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
16
15
  import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
16
+ import { dataConfigMappings } from '@aztec/stdlib/kv-store';
17
17
  import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
18
18
  import { worldStateConfigMappings } from '@aztec/world-state/config';
19
19
  import { DefaultMnemonic } from '../mnemonic.js';
@@ -76,8 +76,7 @@ export const aztecStartOptions = {
76
76
  defaultValue: undefined,
77
77
  env: 'NETWORK'
78
78
  },
79
- configToFlag('--auto-update', sharedNodeConfigMappings.autoUpdate),
80
- configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
79
+ configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
81
80
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
82
81
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
83
82
  configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode)
@@ -111,6 +110,27 @@ export const aztecStartOptions = {
111
110
  env: 'AZTEC_ADMIN_PORT',
112
111
  parseVal: (val)=>parseInt(val, 10)
113
112
  },
113
+ {
114
+ flag: '--admin-api-key-hash <value>',
115
+ description: 'SHA-256 hex hash of a pre-generated admin API key. When set, the node uses this hash for authentication instead of auto-generating a key.',
116
+ defaultValue: undefined,
117
+ env: 'AZTEC_ADMIN_API_KEY_HASH'
118
+ },
119
+ {
120
+ flag: '--disable-admin-api-key',
121
+ description: 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
122
+ defaultValue: false,
123
+ env: 'AZTEC_DISABLE_ADMIN_API_KEY',
124
+ // undefined means the flag was passed without a value (boolean toggle), treat as true.
125
+ parseVal: (val)=>val === undefined || val === 'true' || val === '1'
126
+ },
127
+ {
128
+ flag: '--reset-admin-api-key',
129
+ description: 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
130
+ defaultValue: false,
131
+ env: 'AZTEC_RESET_ADMIN_API_KEY',
132
+ parseVal: (val)=>val === 'true' || val === '1'
133
+ },
114
134
  {
115
135
  flag: '--api-prefix <value>',
116
136
  description: 'Prefix for API routes on any service that is started',
@@ -142,7 +162,7 @@ export const aztecStartOptions = {
142
162
  'WORLD STATE': [
143
163
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
144
164
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
145
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory)
165
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory)
146
166
  ],
147
167
  // We can't easily auto-generate node options as they're parts of modules defined below
148
168
  'AZTEC NODE': [
@@ -186,12 +206,8 @@ export const aztecStartOptions = {
186
206
  },
187
207
  ...getOptions('proverNode', omitConfigMappings(proverNodeConfigMappings, [
188
208
  // filter out options passed separately
189
- ...getKeys(archiverConfigMappings),
190
209
  ...getKeys(proverBrokerConfigMappings),
191
- ...getKeys(proverAgentConfigMappings),
192
- ...getKeys(p2pConfigMappings),
193
- ...getKeys(worldStateConfigMappings),
194
- ...getKeys(sharedNodeConfigMappings)
210
+ ...getKeys(proverAgentConfigMappings)
195
211
  ]))
196
212
  ],
197
213
  'PROVER BROKER': [
package/dest/cli/cli.d.ts CHANGED
@@ -6,4 +6,4 @@ import { Command } from 'commander';
6
6
  * @param debugLogger - logger for logging debug messages.
7
7
  */
8
8
  export declare function injectAztecCommands(program: Command, userLog: LogFn, debugLogger: Logger): Command;
9
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFM0QsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUtwQzs7OztHQUlHO0FBQ0gsd0JBQWdCLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0E0Q2xHIn0=
9
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFM0QsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUtwQzs7OztHQUlHO0FBQ0gsd0JBQWdCLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0EyQ2xHIn0=
@@ -1 +1 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKpC;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CA4ClG"}
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKpC;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CA2ClG"}
package/dest/cli/cli.js CHANGED
@@ -24,10 +24,9 @@ import { addOptions, printAztecStartHelpText } from './util.js';
24
24
  program.addHelpText('after', `
25
25
  Additional commands:
26
26
 
27
- init [folder] [options] creates a new Aztec Noir project.
28
- new <path> [options] creates a new Aztec Noir project in a new directory.
29
- compile [options] compiles Aztec Noir contracts.
30
- test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
27
+ init creates a new Aztec Noir workspace in the current directory.
28
+ 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).
29
+ test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
31
30
  `);
32
31
  }
33
32
  program.command('preload-crs').description('Preload the points data needed for proving and verifying').action(async (options)=>{
@@ -0,0 +1,4 @@
1
+ import type { LogFn } from '@aztec/foundation/log';
2
+ import type { Command } from 'commander';
3
+ export declare function injectCompileCommand(program: Command, log: LogFn): Command;
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGlsZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NsaS9jbWRzL2NvbXBpbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHbkQsT0FBTyxLQUFLLEVBQUUsT0FBTyxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBdUt6Qyx3QkFBZ0Isb0JBQW9CLENBQUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxHQUFHLEVBQUUsS0FBSyxHQUFHLE9BQU8sQ0FzQjFFIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../../src/cli/cmds/compile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAuKzC,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,CAsB1E"}
@@ -0,0 +1,168 @@
1
+ import { findBbBinary } from '@aztec/bb.js';
2
+ import { execFileSync } from 'child_process';
3
+ import { readFile, writeFile } from 'fs/promises';
4
+ import { join } from 'path';
5
+ import { readArtifactFiles } from './utils/artifacts.js';
6
+ import { needsRecompile } from './utils/needs_recompile.js';
7
+ import { run } from './utils/spawn.js';
8
+ import { warnIfAztecVersionMismatch } from './utils/warn_if_aztec_version_mismatch.js';
9
+ /** Returns paths to contract artifacts in the target directory. */ async function collectContractArtifacts() {
10
+ let files;
11
+ try {
12
+ files = await readArtifactFiles('target');
13
+ } catch (err) {
14
+ if (err?.message?.includes('does not exist')) {
15
+ return [];
16
+ }
17
+ throw err;
18
+ }
19
+ return files.filter((f)=>Array.isArray(f.content.functions)).map((f)=>f.filePath);
20
+ }
21
+ /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */ async function stripInternalPrefixes(artifactPaths) {
22
+ for (const path of artifactPaths){
23
+ const artifact = JSON.parse(await readFile(path, 'utf-8'));
24
+ for (const fn of artifact.functions){
25
+ if (typeof fn.name === 'string') {
26
+ fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
27
+ }
28
+ }
29
+ await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
30
+ }
31
+ }
32
+ /** Returns the set of package names that are contract crates in the current workspace. */ async function getContractPackageNames() {
33
+ const contractNames = new Set();
34
+ let rootToml;
35
+ try {
36
+ rootToml = await readFile('Nargo.toml', 'utf-8');
37
+ } catch {
38
+ return contractNames;
39
+ }
40
+ const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
41
+ if (membersMatch) {
42
+ const members = membersMatch[1].split(',').map((m)=>m.trim().replace(/^"|"$/g, '')).filter((m)=>m.length > 0);
43
+ for (const member of members){
44
+ try {
45
+ const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
46
+ if (/type\s*=\s*"contract"/.test(memberToml)) {
47
+ const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
48
+ if (nameMatch) {
49
+ contractNames.add(nameMatch[1]);
50
+ }
51
+ }
52
+ } catch {
53
+ // Member directory might not exist or have no Nargo.toml; skip.
54
+ }
55
+ }
56
+ } else {
57
+ // Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
58
+ if (/type\s*=\s*"contract"/.test(rootToml)) {
59
+ const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
60
+ if (nameMatch) {
61
+ contractNames.add(nameMatch[1]);
62
+ }
63
+ }
64
+ }
65
+ return contractNames;
66
+ }
67
+ /** Checks that no tests exist in contract crates and fails with a helpful message if they do. */ async function checkNoTestsInContracts(nargo, log) {
68
+ const contractPackages = await getContractPackageNames();
69
+ if (contractPackages.size === 0) {
70
+ return;
71
+ }
72
+ let output;
73
+ try {
74
+ // We list tests for all the crates in the workspace
75
+ output = execFileSync(nargo, [
76
+ 'test',
77
+ '--list-tests',
78
+ '--silence-warnings'
79
+ ], {
80
+ encoding: 'utf-8',
81
+ stdio: [
82
+ 'pipe',
83
+ 'pipe',
84
+ 'inherit'
85
+ ]
86
+ });
87
+ } catch {
88
+ // If listing tests fails (e.g. test crate has compile errors), skip the check.
89
+ return;
90
+ }
91
+ // The output of the `nargo test --list-tests` command is as follows:
92
+ // ```
93
+ // crate_name_1 test_name_1
94
+ // crate_name_2 test_name_2
95
+ // ...
96
+ // crate_name_n test_name_n
97
+ // ```
98
+ //
99
+ // We parse the individual lines and then we check if any contract crate appeared in the parsed output.
100
+ const lines = output.trim().split('\n').filter((line)=>line.length > 0);
101
+ const testsInContracts = [];
102
+ for (const line of lines){
103
+ const spaceIndex = line.indexOf(' ');
104
+ if (spaceIndex === -1) {
105
+ continue;
106
+ }
107
+ const packageName = line.substring(0, spaceIndex);
108
+ const testName = line.substring(spaceIndex + 1);
109
+ if (contractPackages.has(packageName)) {
110
+ testsInContracts.push({
111
+ packageName,
112
+ testName
113
+ });
114
+ }
115
+ }
116
+ if (testsInContracts.length > 0) {
117
+ const details = testsInContracts.map((t)=>` ${t.packageName}::${t.testName}`).join('\n');
118
+ log(`WARNING: Found tests in contract crate(s):\n${details}\n\n` + `Tests should be in a dedicated test crate, not in the contract crate.\n` + `Learn more: https://docs.aztec.network/errors/1`);
119
+ }
120
+ }
121
+ /** Compiles Aztec Noir contracts and postprocesses artifacts. */ async function compileAztecContract(nargoArgs, log) {
122
+ await warnIfAztecVersionMismatch(log);
123
+ if (!await needsRecompile()) {
124
+ log('No source changes detected, skipping compilation.');
125
+ return;
126
+ }
127
+ const nargo = process.env.NARGO ?? 'nargo';
128
+ const bb = process.env.BB ?? findBbBinary() ?? 'bb';
129
+ await run(nargo, [
130
+ 'compile',
131
+ ...nargoArgs
132
+ ]);
133
+ // Ensure contract crates contain no tests (tests belong in the test crate).
134
+ await checkNoTestsInContracts(nargo, log);
135
+ const artifacts = await collectContractArtifacts();
136
+ if (artifacts.length > 0) {
137
+ log('Postprocessing contracts...');
138
+ const bbArgs = artifacts.flatMap((a)=>[
139
+ '-i',
140
+ a
141
+ ]);
142
+ await run(bb, [
143
+ 'aztec_process',
144
+ ...bbArgs
145
+ ]);
146
+ // TODO: This should be part of bb aztec_process!
147
+ await stripInternalPrefixes(artifacts);
148
+ }
149
+ log('Compilation complete!');
150
+ }
151
+ export function injectCompileCommand(program, log) {
152
+ program.command('compile').argument('[nargo-args...]').passThroughOptions().allowUnknownOption().description('Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.').addHelpText('after', ()=>{
153
+ // Show nargo's own compile options so users see all available flags in one place.
154
+ const nargo = process.env.NARGO ?? 'nargo';
155
+ try {
156
+ const output = execFileSync(nargo, [
157
+ 'compile',
158
+ '--help'
159
+ ], {
160
+ encoding: 'utf-8'
161
+ });
162
+ return `\nUnderlying nargo compile options:\n\n${output}`;
163
+ } catch {
164
+ return '\n(Run "nargo compile --help" to see available nargo options)';
165
+ }
166
+ }).action((nargoArgs)=>compileAztecContract(nargoArgs, log));
167
+ return program;
168
+ }