@aztec/aztec 3.0.3 → 3.9.9-nightly.20260312

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 (127) 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 -15
  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 +33 -23
  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 +7 -52
  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 +68 -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 +1 -1
  36. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_archiver.js +10 -12
  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/spawn.d.ts +3 -0
  57. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  58. package/dest/cli/cmds/utils/spawn.js +16 -0
  59. package/dest/cli/util.d.ts +7 -18
  60. package/dest/cli/util.d.ts.map +1 -1
  61. package/dest/cli/util.js +48 -84
  62. package/dest/examples/token.js +9 -9
  63. package/dest/local-network/banana_fpc.d.ts +1 -1
  64. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  65. package/dest/local-network/banana_fpc.js +3 -3
  66. package/dest/local-network/local-network.d.ts +6 -5
  67. package/dest/local-network/local-network.d.ts.map +1 -1
  68. package/dest/local-network/local-network.js +74 -30
  69. package/dest/testing/anvil_test_watcher.d.ts +9 -1
  70. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  71. package/dest/testing/anvil_test_watcher.js +52 -15
  72. package/dest/testing/cheat_codes.d.ts +3 -1
  73. package/dest/testing/cheat_codes.d.ts.map +1 -1
  74. package/dest/testing/epoch_test_settler.d.ts +19 -0
  75. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  76. package/dest/testing/epoch_test_settler.js +62 -0
  77. package/dest/testing/index.d.ts +3 -1
  78. package/dest/testing/index.d.ts.map +1 -1
  79. package/dest/testing/index.js +2 -0
  80. package/dest/testing/token_allowed_setup.d.ts +7 -0
  81. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  82. package/dest/testing/token_allowed_setup.js +20 -0
  83. package/package.json +37 -35
  84. package/scripts/aztec.sh +67 -0
  85. package/scripts/init.sh +35 -0
  86. package/scripts/new.sh +59 -0
  87. package/scripts/setup_project.sh +31 -0
  88. package/src/bin/index.ts +9 -3
  89. package/src/cli/admin_api_key_store.ts +128 -0
  90. package/src/cli/aztec_start_action.ts +58 -10
  91. package/src/cli/aztec_start_options.ts +34 -21
  92. package/src/cli/cli.ts +11 -56
  93. package/src/cli/cmds/compile.ts +80 -0
  94. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  95. package/src/cli/cmds/profile.ts +25 -0
  96. package/src/cli/cmds/profile_flamegraph.ts +63 -0
  97. package/src/cli/cmds/profile_gates.ts +67 -0
  98. package/src/cli/cmds/profile_utils.ts +58 -0
  99. package/src/cli/cmds/standby.ts +111 -0
  100. package/src/cli/cmds/start_archiver.ts +6 -17
  101. package/src/cli/cmds/start_bot.ts +8 -5
  102. package/src/cli/cmds/start_node.ts +76 -33
  103. package/src/cli/cmds/start_p2p_bootstrap.ts +2 -2
  104. package/src/cli/cmds/start_prover_agent.ts +3 -11
  105. package/src/cli/cmds/start_prover_broker.ts +12 -15
  106. package/src/cli/cmds/utils/artifacts.ts +44 -0
  107. package/src/cli/cmds/utils/spawn.ts +16 -0
  108. package/src/cli/util.ts +56 -94
  109. package/src/examples/token.ts +10 -10
  110. package/src/local-network/banana_fpc.ts +11 -7
  111. package/src/local-network/local-network.ts +90 -39
  112. package/src/testing/anvil_test_watcher.ts +59 -15
  113. package/src/testing/epoch_test_settler.ts +71 -0
  114. package/src/testing/index.ts +2 -0
  115. package/src/testing/token_allowed_setup.ts +19 -0
  116. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  117. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  118. package/dest/cli/cmds/start_blob_sink.js +0 -33
  119. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  120. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  121. package/dest/cli/cmds/start_prover_node.js +0 -108
  122. package/dest/cli/release_version.d.ts +0 -2
  123. package/dest/cli/release_version.d.ts.map +0 -1
  124. package/dest/cli/release_version.js +0 -14
  125. package/src/cli/cmds/start_blob_sink.ts +0 -57
  126. package/src/cli/cmds/start_prover_node.ts +0 -124
  127. package/src/cli/release_version.ts +0 -21
package/dest/bin/index.js CHANGED
@@ -11,9 +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';
17
+ import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
18
+ import { injectProfileCommand } from '../cli/cmds/profile.js';
15
19
  import { injectAztecCommands } from '../cli/index.js';
16
- import { getCliVersion } from '../cli/release_version.js';
17
20
  const NETWORK_FLAG = 'network';
18
21
  const userLog = createConsoleLogger();
19
22
  const debugLogger = createLogger('cli');
@@ -33,9 +36,9 @@ const debugLogger = createLogger('cli');
33
36
  const networkName = getActiveNetworkName(networkValue);
34
37
  await enrichEnvironmentWithNetworkConfig(networkName);
35
38
  enrichEnvironmentWithChainName(networkName);
36
- const cliVersion = getCliVersion();
39
+ const cliVersion = getPackageVersion() ?? 'unknown';
37
40
  let program = new Command('aztec');
38
- program.description('Aztec command line interface').version(cliVersion);
41
+ program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
39
42
  program = injectAztecCommands(program, userLog, debugLogger);
40
43
  program = injectBuilderCommands(program);
41
44
  program = injectContractCommands(program, userLog, debugLogger);
@@ -44,6 +47,9 @@ const debugLogger = createLogger('cli');
44
47
  program = injectAztecNodeCommands(program, userLog, debugLogger);
45
48
  program = injectMiscCommands(program, userLog);
46
49
  program = injectValidatorKeysCommands(program, userLog);
50
+ program = injectCompileCommand(program, userLog);
51
+ program = injectProfileCommand(program, userLog);
52
+ program = injectMigrateCommand(program, userLog);
47
53
  await program.parseAsync(process.argv);
48
54
  }
49
55
  main().catch((err)=>{
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFLQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFZM0Qsd0JBQXNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUJBNEZqRiJ9
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFPQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFhM0Qsd0JBQXNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUJBeUlqRiJ9
@@ -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,iBA4FjF"}
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,iBAyIjF"}
@@ -1,10 +1,12 @@
1
- import { createNamespacedSafeJsonRpcServer, startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
1
+ import { getActiveNetworkName } from '@aztec/foundation/config';
2
+ import { createNamespacedSafeJsonRpcServer, getApiKeyAuthMiddleware, startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
2
3
  import { 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) {
@@ -14,7 +16,7 @@ export async function aztecStart(options, userLog, debugLogger) {
14
16
  const adminServices = {};
15
17
  let config = undefined;
16
18
  if (options.localNetwork) {
17
- const cliVersion = getCliVersion();
19
+ const cliVersion = getPackageVersion() ?? 'unknown';
18
20
  const localNetwork = extractNamespacedOptions(options, 'local-network');
19
21
  localNetwork.testAccounts = true;
20
22
  userLog(`${splash}\n${github}\n\n`);
@@ -23,7 +25,12 @@ export async function aztecStart(options, userLog, debugLogger) {
23
25
  l1Mnemonic: localNetwork.l1Mnemonic,
24
26
  l1RpcUrls: options.l1RpcUrls,
25
27
  testAccounts: localNetwork.testAccounts,
26
- realProofs: false
28
+ realProofs: false,
29
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
30
+ // the users can consume out hash without having to wait for a long time.
31
+ // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
32
+ // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
33
+ aztecEpochDuration: 2
27
34
  }, userLog);
28
35
  // Start Node and PXE JSON-RPC server
29
36
  signalHandlers.push(stop);
@@ -32,18 +39,17 @@ export async function aztecStart(options, userLog, debugLogger) {
32
39
  AztecNodeApiSchema
33
40
  ];
34
41
  } else {
42
+ // Route --prover-node through startNode
43
+ if (options.proverNode && !options.node) {
44
+ options.node = true;
45
+ }
35
46
  if (options.node) {
36
47
  const { startNode } = await import('./cmds/start_node.js');
37
- ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
48
+ const networkName = getActiveNetworkName(options.network);
49
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
38
50
  } else if (options.bot) {
39
51
  const { startBot } = await import('./cmds/start_bot.js');
40
52
  await startBot(options, signalHandlers, services, userLog);
41
- } else if (options.proverNode) {
42
- const { startProverNode } = await import('./cmds/start_prover_node.js');
43
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
44
- } else if (options.blobSink) {
45
- const { startBlobSink } = await import('./cmds/start_blob_sink.js');
46
- await startBlobSink(options, signalHandlers, userLog);
47
53
  } else if (options.archiver) {
48
54
  const { startArchiver } = await import('./cmds/start_archiver.js');
49
55
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -88,13 +94,26 @@ export async function aztecStart(options, userLog, debugLogger) {
88
94
  }
89
95
  // If there are any admin services, start a separate JSON-RPC server for them
90
96
  if (Object.entries(adminServices).length > 0) {
97
+ const adminMiddlewares = [
98
+ getOtelJsonRpcPropagationMiddleware(),
99
+ getVersioningMiddleware(versions)
100
+ ];
101
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
102
+ const apiKeyResolution = await resolveAdminApiKey({
103
+ adminApiKeyHash: options.adminApiKeyHash,
104
+ disableAdminApiKey: options.disableAdminApiKey,
105
+ resetAdminApiKey: options.resetAdminApiKey,
106
+ dataDirectory: options.dataDirectory
107
+ }, debugLogger);
108
+ if (apiKeyResolution) {
109
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
110
+ } else {
111
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
112
+ }
91
113
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
92
114
  http200OnError: false,
93
115
  log: debugLogger,
94
- middlewares: [
95
- getOtelJsonRpcPropagationMiddleware(),
96
- getVersioningMiddleware(versions)
97
- ],
116
+ middlewares: adminMiddlewares,
98
117
  maxBatchSize: options.rpcMaxBatchSize,
99
118
  maxBodySizeBytes: options.rpcMaxBodySize
100
119
  });
@@ -102,5 +121,26 @@ export async function aztecStart(options, userLog, debugLogger) {
102
121
  port: options.adminPort
103
122
  });
104
123
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
124
+ // Display the API key after the server has started
125
+ // Uses userLog which is never filtered by LOG_LEVEL.
126
+ if (apiKeyResolution?.rawKey) {
127
+ const separator = '='.repeat(70);
128
+ userLog('');
129
+ userLog(separator);
130
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
131
+ userLog('');
132
+ userLog(` ${apiKeyResolution.rawKey}`);
133
+ userLog('');
134
+ userLog(` Use via header: x-api-key: <key>`);
135
+ userLog(` Or via header: Authorization: Bearer <key>`);
136
+ if (options.dataDirectory) {
137
+ userLog('');
138
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
139
+ }
140
+ userLog('');
141
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
142
+ userLog(separator);
143
+ userLog('');
144
+ }
105
145
  }
106
146
  }
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfb3B0aW9ucy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9henRlY19zdGFydF9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFDTCxLQUFLLGFBQWEsRUFDbEIsS0FBSyxNQUFNLEVBSVosTUFBTSwwQkFBMEIsQ0FBQztBQWVsQyxNQUFNLFdBQVcsZ0JBQWdCO0lBQy9CLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYixXQUFXLEVBQUUsTUFBTSxDQUFDO0lBQ3BCLFlBQVksRUFBRSxHQUFHLENBQUM7SUFDbEIsWUFBWSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLE1BQU0sQ0FBQztJQUNwQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUN4QixRQUFRLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNwQixRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssR0FBRyxDQUFDO0NBQ2pDO0FBRUQsZUFBTyxNQUFNLFVBQVUsMEZBb0J0QixDQUFDO0FBdUJGLGVBQU8sTUFBTSxnQkFBZ0IsVUFZNUIsQ0FBQztBQUVGLGVBQU8sTUFBTSxZQUFZLFlBQVksQ0FBQztBQUd0QyxlQUFPLE1BQU0saUJBQWlCLEVBQUU7SUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQTtDQXlObEUsQ0FBQyJ9
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;CAyNlE,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"}
@@ -1,5 +1,5 @@
1
1
  import { archiverConfigMappings } from '@aztec/archiver/config';
2
- import { blobSinkConfigMappings } from '@aztec/blob-sink/server/config';
2
+ import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
3
3
  import { botConfigMappings } from '@aztec/bot/config';
4
4
  import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
5
5
  import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
@@ -13,7 +13,7 @@ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/pr
13
13
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
14
14
  import { allPxeConfigMappings } from '@aztec/pxe/config';
15
15
  import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
16
- import { chainConfigMappings } from '@aztec/stdlib/config';
16
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
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,12 +110,35 @@ 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',
117
137
  defaultValue: '',
118
138
  env: 'API_PREFIX'
119
- }
139
+ },
140
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
141
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize)
120
142
  ],
121
143
  ETHEREUM: [
122
144
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
@@ -125,9 +147,9 @@ export const aztecStartOptions = {
125
147
  ...l1ReaderConfigMappings.l1RpcUrls,
126
148
  defaultValue: undefined
127
149
  }),
128
- configToFlag('--l1-consensus-host-urls', blobSinkConfigMappings.l1ConsensusHostUrls),
129
- configToFlag('--l1-consensus-host-api-keys', blobSinkConfigMappings.l1ConsensusHostApiKeys),
130
- configToFlag('--l1-consensus-host-api-key-headers', blobSinkConfigMappings.l1ConsensusHostApiKeyHeaders)
150
+ configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
151
+ configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
152
+ configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders)
131
153
  ],
132
154
  'L1 CONTRACTS': [
133
155
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -140,7 +162,7 @@ export const aztecStartOptions = {
140
162
  'WORLD STATE': [
141
163
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
142
164
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
143
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory)
165
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory)
144
166
  ],
145
167
  // We can't easily auto-generate node options as they're parts of modules defined below
146
168
  'AZTEC NODE': [
@@ -169,20 +191,12 @@ export const aztecStartOptions = {
169
191
  },
170
192
  ...getOptions('sequencer', omitConfigMappings(sequencerClientConfigMappings, [
171
193
  'fakeProcessingDelayPerTxMs',
194
+ 'fakeThrowAfterProcessingTxCount',
172
195
  'skipCollectingAttestations',
173
196
  'skipInvalidateBlockAsProposer',
174
197
  'blobSinkMapSizeKb'
175
198
  ]))
176
199
  ],
177
- 'BLOB SINK': [
178
- {
179
- flag: '--blob-sink',
180
- description: 'Starts Aztec Blob Sink with options',
181
- defaultValue: undefined,
182
- env: undefined
183
- },
184
- ...getOptions('blobSink', blobSinkConfigMappings)
185
- ],
186
200
  'PROVER NODE': [
187
201
  {
188
202
  flag: '--prover-node',
@@ -192,12 +206,8 @@ export const aztecStartOptions = {
192
206
  },
193
207
  ...getOptions('proverNode', omitConfigMappings(proverNodeConfigMappings, [
194
208
  // filter out options passed separately
195
- ...getKeys(archiverConfigMappings),
196
209
  ...getKeys(proverBrokerConfigMappings),
197
- ...getKeys(proverAgentConfigMappings),
198
- ...getKeys(p2pConfigMappings),
199
- ...getKeys(worldStateConfigMappings),
200
- ...getKeys(sharedNodeConfigMappings)
210
+ ...getKeys(proverAgentConfigMappings)
201
211
  ]))
202
212
  ],
203
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFM0QsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUtwQzs7OztHQUlHO0FBQ0gsd0JBQWdCLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0F3RmxHIn0=
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,CAwFlG"}
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
@@ -20,60 +20,15 @@ import { addOptions, printAztecStartHelpText } from './util.js';
20
20
  program.configureHelp({
21
21
  sortSubcommands: true
22
22
  });
23
- program.addHelpText('after', `
23
+ if (process.env.AZTEC_SHELL_WRAPPER) {
24
+ program.addHelpText('after', `
25
+ Additional commands:
24
26
 
25
- Additional commands:
26
-
27
- init [folder] [options]: creates a new Noir project
28
- Options:
29
- --name <name> Name of the package
30
- --contract Use a contract template (default)
31
- --lib Use a library template
32
- --bin Use a binary template
33
- Examples:
34
- $ aztec init # creates a contract project in current directory
35
- $ aztec init --lib # creates a library project
36
-
37
- new <path> [options]: creates a new Noir project in a new directory
38
- Options:
39
- --name <name> Name of the package
40
- --contract Use a contract template (default)
41
- --lib Use a library template
42
- --bin Use a binary template
43
- Examples:
44
- $ aztec new my-project # creates a contract project in ./my-project
45
- $ aztec new my-lib --lib # creates a library project in ./my-lib
46
-
47
- compile [options]: compiles Aztec Noir contracts
48
- Compiles contracts with nargo compile and then postprocesses them to generate Aztec-specific artifacts including:
49
- - Transpiled contract artifacts
50
- - Verification keys
51
- The compiled contracts will be placed in the target/ directory by default.
52
- Supports standard nargo compile options.
53
-
54
- fmt [options]: formats Noir code using nargo fmt
55
- Example:
56
- $ aztec fmt # formats all Noir files in the project
57
-
58
- check [options]: type-checks Noir code without compiling using nargo check
59
- Example:
60
- $ aztec check # checks all Noir files in the project
61
-
62
- test [options]: starts a dockerized TXE node via
63
- $ aztec start --txe
64
- then runs
65
- $ aztec test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
66
-
67
- lsp: starts the Nargo Language Server Protocol server
68
- Runs nargo lsp in a Docker container for IDE integration with Noir.
69
- This command is typically used by IDE extensions and not called directly by users.
70
- Example:
71
- $ aztec lsp # starts the LSP server
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
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
+ test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
76
30
  `);
31
+ }
77
32
  program.command('preload-crs').description('Preload the points data needed for proving and verifying').action(async (options)=>{
78
33
  const { preloadCrs } = await import('./preload_crs.js');
79
34
  return await preloadCrs(options, userLog, debugLogger);
@@ -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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGlsZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NsaS9jbWRzL2NvbXBpbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHbkQsT0FBTyxLQUFLLEVBQUUsT0FBTyxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBc0R6Qyx3QkFBZ0Isb0JBQW9CLENBQUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxHQUFHLEVBQUUsS0FBSyxHQUFHLE9BQU8sQ0FzQjFFIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../../src/cli/cmds/compile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAsDzC,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,CAsB1E"}
@@ -0,0 +1,68 @@
1
+ import { execFileSync } from 'child_process';
2
+ import { readFile, writeFile } from 'fs/promises';
3
+ import { readArtifactFiles } from './utils/artifacts.js';
4
+ import { run } from './utils/spawn.js';
5
+ /** Returns paths to contract artifacts in the target directory. */ async function collectContractArtifacts() {
6
+ let files;
7
+ try {
8
+ files = await readArtifactFiles('target');
9
+ } catch (err) {
10
+ if (err?.message?.includes('does not exist')) {
11
+ return [];
12
+ }
13
+ throw err;
14
+ }
15
+ return files.filter((f)=>Array.isArray(f.content.functions)).map((f)=>f.filePath);
16
+ }
17
+ /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */ async function stripInternalPrefixes(artifactPaths) {
18
+ for (const path of artifactPaths){
19
+ const artifact = JSON.parse(await readFile(path, 'utf-8'));
20
+ for (const fn of artifact.functions){
21
+ if (typeof fn.name === 'string') {
22
+ fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
23
+ }
24
+ }
25
+ await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
26
+ }
27
+ }
28
+ /** Compiles Aztec Noir contracts and postprocesses artifacts. */ async function compileAztecContract(nargoArgs, log) {
29
+ const nargo = process.env.NARGO ?? 'nargo';
30
+ const bb = process.env.BB ?? 'bb';
31
+ await run(nargo, [
32
+ 'compile',
33
+ ...nargoArgs
34
+ ]);
35
+ const artifacts = await collectContractArtifacts();
36
+ if (artifacts.length > 0) {
37
+ log('Postprocessing contracts...');
38
+ const bbArgs = artifacts.flatMap((a)=>[
39
+ '-i',
40
+ a
41
+ ]);
42
+ await run(bb, [
43
+ 'aztec_process',
44
+ ...bbArgs
45
+ ]);
46
+ // TODO: This should be part of bb aztec_process!
47
+ await stripInternalPrefixes(artifacts);
48
+ }
49
+ log('Compilation complete!');
50
+ }
51
+ export function injectCompileCommand(program, log) {
52
+ 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', ()=>{
53
+ // Show nargo's own compile options so users see all available flags in one place.
54
+ const nargo = process.env.NARGO ?? 'nargo';
55
+ try {
56
+ const output = execFileSync(nargo, [
57
+ 'compile',
58
+ '--help'
59
+ ], {
60
+ encoding: 'utf-8'
61
+ });
62
+ return `\nUnderlying nargo compile options:\n\n${output}`;
63
+ } catch {
64
+ return '\n(Run "nargo compile --help" to see available nargo options)';
65
+ }
66
+ }).action((nargoArgs)=>compileAztecContract(nargoArgs, log));
67
+ return program;
68
+ }
@@ -0,0 +1,3 @@
1
+ import type { Command } from 'commander';
2
+ export declare function injectMigrateCommand(program: Command, log: (msg: string) => void): Command;
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlncmF0ZV9oYV9kYi5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NsaS9jbWRzL21pZ3JhdGVfaGFfZGIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsT0FBTyxLQUFLLEVBQUUsT0FBTyxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBRXpDLHdCQUFnQixvQkFBb0IsQ0FBQyxPQUFPLEVBQUUsT0FBTyxFQUFFLEdBQUcsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssSUFBSSxHQUFHLE9BQU8sQ0FzQzFGIn0=
@@ -0,0 +1 @@
1
+ {"version":3,"file":"migrate_ha_db.d.ts","sourceRoot":"","sources":["../../../src/cli/cmds/migrate_ha_db.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAsC1F"}