@aztec-labs/aztec 6.0.0-nightly.20260829

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 (187) hide show
  1. package/README.md +57 -0
  2. package/dest/bin/index.d.ts +3 -0
  3. package/dest/bin/index.d.ts.map +1 -0
  4. package/dest/bin/index.js +61 -0
  5. package/dest/cli/admin_api_key_store.d.ts +45 -0
  6. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  7. package/dest/cli/admin_api_key_store.js +98 -0
  8. package/dest/cli/aztec_start_action.d.ts +3 -0
  9. package/dest/cli/aztec_start_action.d.ts.map +1 -0
  10. package/dest/cli/aztec_start_action.js +153 -0
  11. package/dest/cli/aztec_start_options.d.ts +17 -0
  12. package/dest/cli/aztec_start_options.d.ts.map +1 -0
  13. package/dest/cli/aztec_start_options.js +290 -0
  14. package/dest/cli/cli.d.ts +9 -0
  15. package/dest/cli/cli.d.ts.map +1 -0
  16. package/dest/cli/cli.js +37 -0
  17. package/dest/cli/cmds/compile.d.ts +4 -0
  18. package/dest/cli/cmds/compile.d.ts.map +1 -0
  19. package/dest/cli/cmds/compile.js +174 -0
  20. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  21. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  22. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  23. package/dest/cli/cmds/profile.d.ts +4 -0
  24. package/dest/cli/cmds/profile.d.ts.map +1 -0
  25. package/dest/cli/cmds/profile.js +8 -0
  26. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  27. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  28. package/dest/cli/cmds/profile_flamegraph.js +52 -0
  29. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  30. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  31. package/dest/cli/cmds/profile_gates.js +76 -0
  32. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  33. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  34. package/dest/cli/cmds/profile_utils.js +50 -0
  35. package/dest/cli/cmds/prover.d.ts +4 -0
  36. package/dest/cli/cmds/prover.d.ts.map +1 -0
  37. package/dest/cli/cmds/prover.js +24 -0
  38. package/dest/cli/cmds/standby.d.ts +56 -0
  39. package/dest/cli/cmds/standby.d.ts.map +1 -0
  40. package/dest/cli/cmds/standby.js +140 -0
  41. package/dest/cli/cmds/start_bot.d.ts +8 -0
  42. package/dest/cli/cmds/start_bot.d.ts.map +1 -0
  43. package/dest/cli/cmds/start_bot.js +53 -0
  44. package/dest/cli/cmds/start_node.d.ts +8 -0
  45. package/dest/cli/cmds/start_node.d.ts.map +1 -0
  46. package/dest/cli/cmds/start_node.js +150 -0
  47. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +6 -0
  48. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -0
  49. package/dest/cli/cmds/start_p2p_bootstrap.js +30 -0
  50. package/dest/cli/cmds/start_prover_agent.d.ts +4 -0
  51. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -0
  52. package/dest/cli/cmds/start_prover_agent.js +58 -0
  53. package/dest/cli/cmds/start_prover_broker.d.ts +9 -0
  54. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -0
  55. package/dest/cli/cmds/start_prover_broker.js +46 -0
  56. package/dest/cli/cmds/start_txe.d.ts +3 -0
  57. package/dest/cli/cmds/start_txe.d.ts.map +1 -0
  58. package/dest/cli/cmds/start_txe.js +12 -0
  59. package/dest/cli/cmds/utils/artifacts.d.ts +26 -0
  60. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  61. package/dest/cli/cmds/utils/artifacts.js +24 -0
  62. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts +21 -0
  63. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
  64. package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
  65. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  66. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  67. package/dest/cli/cmds/utils/needs_recompile.js +90 -0
  68. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  69. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  70. package/dest/cli/cmds/utils/spawn.js +16 -0
  71. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
  72. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
  73. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +61 -0
  74. package/dest/cli/index.d.ts +2 -0
  75. package/dest/cli/index.d.ts.map +1 -0
  76. package/dest/cli/index.js +1 -0
  77. package/dest/cli/preload_crs.d.ts +3 -0
  78. package/dest/cli/preload_crs.d.ts.map +1 -0
  79. package/dest/cli/preload_crs.js +6 -0
  80. package/dest/cli/util.d.ts +71 -0
  81. package/dest/cli/util.d.ts.map +1 -0
  82. package/dest/cli/util.js +261 -0
  83. package/dest/cli/versioning.d.ts +4 -0
  84. package/dest/cli/versioning.d.ts.map +1 -0
  85. package/dest/cli/versioning.js +9 -0
  86. package/dest/examples/token.d.ts +2 -0
  87. package/dest/examples/token.d.ts.map +1 -0
  88. package/dest/examples/token.js +59 -0
  89. package/dest/examples/util.d.ts +19 -0
  90. package/dest/examples/util.d.ts.map +1 -0
  91. package/dest/examples/util.js +30 -0
  92. package/dest/index.d.ts +2 -0
  93. package/dest/index.d.ts.map +1 -0
  94. package/dest/index.js +1 -0
  95. package/dest/local-network/auth_registry.d.ts +5 -0
  96. package/dest/local-network/auth_registry.d.ts.map +1 -0
  97. package/dest/local-network/auth_registry.js +17 -0
  98. package/dest/local-network/banana_fpc.d.ts +11 -0
  99. package/dest/local-network/banana_fpc.d.ts.map +1 -0
  100. package/dest/local-network/banana_fpc.js +81 -0
  101. package/dest/local-network/index.d.ts +4 -0
  102. package/dest/local-network/index.d.ts.map +1 -0
  103. package/dest/local-network/index.js +3 -0
  104. package/dest/local-network/local-network.d.ts +51 -0
  105. package/dest/local-network/local-network.d.ts.map +1 -0
  106. package/dest/local-network/local-network.js +205 -0
  107. package/dest/local-network/sponsored_fpc.d.ts +5 -0
  108. package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
  109. package/dest/local-network/sponsored_fpc.js +18 -0
  110. package/dest/mnemonic.d.ts +2 -0
  111. package/dest/mnemonic.d.ts.map +1 -0
  112. package/dest/mnemonic.js +1 -0
  113. package/dest/splash.d.ts +3 -0
  114. package/dest/splash.d.ts.map +1 -0
  115. package/dest/splash.js +2 -0
  116. package/dest/testing/cheat_codes.d.ts +37 -0
  117. package/dest/testing/cheat_codes.d.ts.map +1 -0
  118. package/dest/testing/cheat_codes.js +36 -0
  119. package/dest/testing/epoch_test_settler.d.ts +19 -0
  120. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  121. package/dest/testing/epoch_test_settler.js +42 -0
  122. package/dest/testing/index.d.ts +6 -0
  123. package/dest/testing/index.d.ts.map +1 -0
  124. package/dest/testing/index.js +5 -0
  125. package/dest/testing/local-network.d.ts +51 -0
  126. package/dest/testing/local-network.d.ts.map +1 -0
  127. package/dest/testing/local-network.js +60 -0
  128. package/dest/testing/token_allowed_setup.d.ts +12 -0
  129. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  130. package/dest/testing/token_allowed_setup.js +24 -0
  131. package/package.json +125 -0
  132. package/scripts/add_crate.sh +53 -0
  133. package/scripts/aztec.sh +73 -0
  134. package/scripts/init.sh +39 -0
  135. package/scripts/new.sh +83 -0
  136. package/scripts/setup_workspace.sh +69 -0
  137. package/scripts/templates/blank/contract/Nargo.toml +6 -0
  138. package/scripts/templates/blank/contract/src/main.nr +10 -0
  139. package/scripts/templates/blank/test/Nargo.toml +7 -0
  140. package/scripts/templates/blank/test/src/lib.nr +11 -0
  141. package/scripts/templates/counter/contract/Nargo.toml +7 -0
  142. package/scripts/templates/counter/contract/src/main.nr +48 -0
  143. package/scripts/templates/counter/test/Nargo.toml +7 -0
  144. package/scripts/templates/counter/test/src/lib.nr +32 -0
  145. package/src/bin/index.ts +73 -0
  146. package/src/cli/admin_api_key_store.ts +127 -0
  147. package/src/cli/aztec_start_action.ts +173 -0
  148. package/src/cli/aztec_start_options.ts +333 -0
  149. package/src/cli/cli.ts +55 -0
  150. package/src/cli/cmds/compile.ts +205 -0
  151. package/src/cli/cmds/migrate_ha_db.ts +42 -0
  152. package/src/cli/cmds/profile.ts +25 -0
  153. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  154. package/src/cli/cmds/profile_gates.ts +84 -0
  155. package/src/cli/cmds/profile_utils.ts +58 -0
  156. package/src/cli/cmds/prover.ts +41 -0
  157. package/src/cli/cmds/standby.ts +183 -0
  158. package/src/cli/cmds/start_bot.ts +78 -0
  159. package/src/cli/cmds/start_node.ts +199 -0
  160. package/src/cli/cmds/start_p2p_bootstrap.ts +37 -0
  161. package/src/cli/cmds/start_prover_agent.ts +77 -0
  162. package/src/cli/cmds/start_prover_broker.ts +69 -0
  163. package/src/cli/cmds/start_txe.ts +17 -0
  164. package/src/cli/cmds/utils/artifacts.ts +49 -0
  165. package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
  166. package/src/cli/cmds/utils/needs_recompile.ts +98 -0
  167. package/src/cli/cmds/utils/spawn.ts +16 -0
  168. package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +75 -0
  169. package/src/cli/index.ts +1 -0
  170. package/src/cli/preload_crs.ts +7 -0
  171. package/src/cli/util.ts +310 -0
  172. package/src/cli/versioning.ts +13 -0
  173. package/src/examples/token.ts +77 -0
  174. package/src/examples/util.ts +42 -0
  175. package/src/index.ts +6 -0
  176. package/src/local-network/auth_registry.ts +19 -0
  177. package/src/local-network/banana_fpc.ts +89 -0
  178. package/src/local-network/index.ts +7 -0
  179. package/src/local-network/local-network.ts +254 -0
  180. package/src/local-network/sponsored_fpc.ts +26 -0
  181. package/src/mnemonic.ts +1 -0
  182. package/src/splash.ts +10 -0
  183. package/src/testing/cheat_codes.ts +48 -0
  184. package/src/testing/epoch_test_settler.ts +47 -0
  185. package/src/testing/index.ts +5 -0
  186. package/src/testing/local-network.ts +96 -0
  187. package/src/testing/token_allowed_setup.ts +26 -0
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # aztec
2
+
3
+ Aztec is a package that allows for a simple development environment on Aztec stack. It creates a Private eXecution Environment (PXE) that listens for HTTP requests on `localhost:8080` by default. When started, it deploys all necessary L1 Aztec contracts and then starts listening for RPC requests.
4
+
5
+ ## How to run:
6
+
7
+ ### Docker Compose
8
+
9
+ The easiest way to run is by using `docker compose up`. This will create two containers:
10
+
11
+ 1. The local network listening on port `8080`
12
+ 2. An anvil instance listening on port `8545`
13
+
14
+ ### Node Server
15
+
16
+ You can also run it as a standalone node server with:
17
+
18
+ ```sh
19
+ yarn start
20
+ ```
21
+
22
+ It will look for a local Ethereum RPC to talk to but you can change this with the `ETHEREUM_HOSTS` environment variable.
23
+
24
+ ## Examples
25
+
26
+ The package also includes 2 examples. There are some system prerequisites that you will need to run these locally:
27
+
28
+ - [nvm](https://github.com/nvm-sh/nvm)
29
+ - Node version > 18
30
+ - [yarn](https://yarnpkg.com/)
31
+ - [jq](https://jqlang.github.io/jq/download/)
32
+
33
+ Before running locally you'll need to:
34
+
35
+ - Head to `l1-contracts` directory and run `./bootstrap.sh`
36
+ - Then go to `yarn-project and run:
37
+ - `yarn install`
38
+ - `yarn build`
39
+ And you should be good to go!
40
+
41
+ From the `aztec` directory, you can run the two existing examples:
42
+
43
+ - Deployment, mint and transfer on an Aztec Private Token
44
+ - `yarn run:example:token`
45
+ - An L1 / L2 uniswap token trade.
46
+ - `yarn run:example:uniswap`
47
+ - To run this example, you need to set the following vars:
48
+
49
+ ```
50
+ export FORK_BLOCK_NUMBER=17514288
51
+ export FORK_URL=<YOUR_RPC_URL e.g. https://mainnet.infura.io/v3/API_KEY>
52
+ ```
53
+
54
+ ## Publishing
55
+
56
+ This package is set-up to be published on dockerhub by CI whenever there's a tagged release on `master` branch.
57
+ It's published under the tags `azteclabs/aztec:latest` & `azteclabs/aztec:<version-tag>`.
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iaW4vaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":""}
@@ -0,0 +1,61 @@
1
+ #!/usr/bin/env node
2
+ //
3
+ import { injectCommands as injectBuilderCommands } from '@aztec-labs/builder';
4
+ import { injectCommands as injectAztecNodeCommands } from '@aztec-labs/cli/aztec_node';
5
+ import { enrichEnvironmentWithChainName } from '@aztec-labs/cli/config/chain';
6
+ import { enrichEnvironmentWithNetworkConfig } from '@aztec-labs/cli/config/network';
7
+ import { injectCommands as injectInfrastructureCommands } from '@aztec-labs/cli/infrastructure';
8
+ import { injectCommands as injectL1Commands } from '@aztec-labs/cli/l1';
9
+ import { injectCommands as injectMiscCommands } from '@aztec-labs/cli/misc';
10
+ import { injectCommands as injectValidatorKeysCommands } from '@aztec-labs/cli/validator_keys';
11
+ import { getActiveNetworkName } from '@aztec-labs/foundation/config';
12
+ import { createConsoleLogger, createLogger } from '@aztec-labs/foundation/log';
13
+ import { getPackageVersion } from '@aztec-labs/stdlib/update-checker';
14
+ import { Command } from 'commander';
15
+ import { injectCompileCommand } from '../cli/cmds/compile.js';
16
+ import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
17
+ import { injectProfileCommand } from '../cli/cmds/profile.js';
18
+ import { injectProverCommand } from '../cli/cmds/prover.js';
19
+ import { injectAztecCommands } from '../cli/index.js';
20
+ const NETWORK_FLAG = 'network';
21
+ const userLog = createConsoleLogger();
22
+ const debugLogger = createLogger('cli');
23
+ /** CLI & full node main entrypoint */ async function main() {
24
+ const shutdown = ()=>{
25
+ process.exit(0);
26
+ };
27
+ process.once('SIGINT', shutdown);
28
+ process.once('SIGTERM', shutdown);
29
+ // Intercept the setting of a network and enrich the environment with defaults for that network
30
+ let networkValue;
31
+ const args = process.argv.slice(2);
32
+ const networkIndex = args.findIndex((arg)=>arg.startsWith(`--${NETWORK_FLAG}=`) || arg === `--${NETWORK_FLAG}`);
33
+ if (networkIndex !== -1) {
34
+ networkValue = args[networkIndex].split('=')[1] || args[networkIndex + 1];
35
+ }
36
+ const networkName = getActiveNetworkName(networkValue);
37
+ await enrichEnvironmentWithNetworkConfig(networkName);
38
+ enrichEnvironmentWithChainName(networkName);
39
+ const cliVersion = getPackageVersion();
40
+ let program = new Command('aztec');
41
+ program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
42
+ program = injectAztecCommands(program, userLog, debugLogger);
43
+ program = injectBuilderCommands(program);
44
+ program = injectInfrastructureCommands(program, userLog);
45
+ program = injectL1Commands(program, userLog, debugLogger);
46
+ program = injectAztecNodeCommands(program, userLog, debugLogger);
47
+ program = injectMiscCommands(program, userLog);
48
+ program = injectValidatorKeysCommands(program, userLog);
49
+ program = injectCompileCommand(program, userLog);
50
+ program = injectProfileCommand(program, userLog);
51
+ program = injectMigrateCommand(program, userLog);
52
+ program = injectProverCommand(program, userLog);
53
+ await program.parseAsync(process.argv);
54
+ }
55
+ main().catch((err)=>{
56
+ debugLogger.error(`Error in command execution`);
57
+ debugLogger.error(err + '\n' + err.stack);
58
+ // See https://nodejs.org/api/process.html#processexitcode
59
+ process.exitCode = 1;
60
+ throw err;
61
+ });
@@ -0,0 +1,45 @@
1
+ import type { Logger } from '@aztec-labs/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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWRtaW5fYXBpX2tleV9zdG9yZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9hZG1pbl9hcGlfa2V5X3N0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBUXpEOzs7O0dBSUc7QUFDSCxNQUFNLFdBQVcscUJBQXFCO0lBQ3BDLHVDQUF1QztJQUN2QyxVQUFVLEVBQUUsTUFBTSxDQUFDO0lBQ25COzs7T0FHRztJQUNILE1BQU0sQ0FBQyxFQUFFLE1BQU0sQ0FBQztDQUNqQjtBQUVELE1BQU0sV0FBVyx5QkFBeUI7SUFDeEMsK0ZBQStGO0lBQy9GLGVBQWUsQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUN6QixvREFBb0Q7SUFDcEQsa0JBQWtCLENBQUMsRUFBRSxPQUFPLENBQUM7SUFDN0IsMEVBQTBFO0lBQzFFLGdCQUFnQixDQUFDLEVBQUUsT0FBTyxDQUFDO0lBQzNCLGtEQUFrRDtJQUNsRCxhQUFhLENBQUMsRUFBRSxNQUFNLENBQUM7Q0FDeEI7QUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FpQkc7QUFDSCx3QkFBc0Isa0JBQWtCLENBQ3RDLE9BQU8sRUFBRSx5QkFBeUIsRUFDbEMsR0FBRyxFQUFFLE1BQU0sR0FDVixPQUFPLENBQUMscUJBQXFCLEdBQUcsU0FBUyxDQUFDLENBMkQ1QyJ9
@@ -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,4BAA4B,CAAC;AAQzD;;;;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-labs/foundation/crypto/random';
2
+ import { sha256Hash } from '@aztec-labs/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
+ }
@@ -0,0 +1,3 @@
1
+ import type { LogFn, Logger } from '@aztec-labs/foundation/log';
2
+ export declare function aztecStart(options: any, userLog: LogFn, debugLogger: Logger): Promise<void>;
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFRQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFnQmhFLHdCQUFzQixVQUFVLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLGlCQW9KakYifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"aztec_start_action.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_action.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAgBhE,wBAAsB,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iBAoJjF"}
@@ -0,0 +1,153 @@
1
+ import { registerAztecNodeRpcHandlers } from '@aztec-labs/aztec-node';
2
+ import { getActiveNetworkName } from '@aztec-labs/foundation/config';
3
+ import { createNamespacedSafeJsonRpcServer, getApiKeyAuthMiddleware, startHttpRpcServer } from '@aztec-labs/foundation/json-rpc/server';
4
+ import { getRpcCorsAllowedOrigins } from '@aztec-labs/stdlib/config';
5
+ import { getPackageVersion } from '@aztec-labs/stdlib/update-checker';
6
+ import { getVersioningMiddleware } from '@aztec-labs/stdlib/versioning';
7
+ import { getOtelJsonRpcDiagnosticsMiddleware, getOtelJsonRpcPropagationMiddleware, getOtelJsonRpcServerMetricsMiddleware } from '@aztec-labs/telemetry-client';
8
+ import { createLocalNetwork } from '../local-network/index.js';
9
+ import { github, splash } from '../splash.js';
10
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
11
+ import { extractNamespacedOptions, installSignalHandlers } from './util.js';
12
+ import { getVersions } from './versioning.js';
13
+ export async function aztecStart(options, userLog, debugLogger) {
14
+ // list of 'stop' functions to call when process ends
15
+ const signalHandlers = [];
16
+ const services = {};
17
+ const adminServices = {};
18
+ const packageVersion = getPackageVersion();
19
+ let config = undefined;
20
+ if (options.localNetwork) {
21
+ const localNetwork = extractNamespacedOptions(options, 'localNetwork');
22
+ userLog(`${splash}\n${github}\n\n`);
23
+ userLog(`Setting up Aztec local network ${packageVersion}, please stand by...`);
24
+ const { node, stop } = await createLocalNetwork({
25
+ l1Mnemonic: localNetwork.l1Mnemonic,
26
+ l1RpcUrls: options.l1RpcUrls,
27
+ testAccounts: localNetwork.testAccounts
28
+ }, userLog);
29
+ // Start Node and PXE JSON-RPC server
30
+ signalHandlers.push(stop);
31
+ registerAztecNodeRpcHandlers(node, services, adminServices, {
32
+ debug: true
33
+ });
34
+ } else {
35
+ // Route --prover-node through startNode
36
+ if (options.proverNode && !options.node) {
37
+ options.node = true;
38
+ }
39
+ if (options.node) {
40
+ const { startNode } = await import('./cmds/start_node.js');
41
+ const networkName = getActiveNetworkName(options.network);
42
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
43
+ } else if (options.bot) {
44
+ const { startBot } = await import('./cmds/start_bot.js');
45
+ await startBot(options, signalHandlers, services, userLog);
46
+ } else if (options.p2pBootstrap) {
47
+ const { startP2PBootstrap } = await import('./cmds/start_p2p_bootstrap.js');
48
+ ({ config } = await startP2PBootstrap(options, signalHandlers, services, userLog));
49
+ } else if (options.proverAgent) {
50
+ const { startProverAgent } = await import('./cmds/start_prover_agent.js');
51
+ await startProverAgent(options, signalHandlers, services, userLog);
52
+ } else if (options.proverBroker) {
53
+ const { startProverBroker } = await import('./cmds/start_prover_broker.js');
54
+ await startProverBroker(options, signalHandlers, services, userLog);
55
+ } else if (options.txe) {
56
+ const { startTXE } = await import('./cmds/start_txe.js');
57
+ await startTXE(options, signalHandlers, debugLogger);
58
+ } else if (options.sequencer) {
59
+ userLog(`Cannot run a standalone sequencer without a node`);
60
+ process.exit(1);
61
+ } else {
62
+ userLog(`No module specified to start`);
63
+ process.exit(1);
64
+ }
65
+ }
66
+ installSignalHandlers(debugLogger.info, signalHandlers);
67
+ const versions = getVersions(config);
68
+ const versioningOpts = {
69
+ packageVersion
70
+ };
71
+ // Start the main JSON-RPC server
72
+ if (Object.entries(services).length > 0) {
73
+ if (services.aztec) {
74
+ const { BarretenbergSync } = await import('@aztec/bb.js');
75
+ // JSON-RPC schema parsing may decompress compressed Chonk proofs before the node handler runs.
76
+ await BarretenbergSync.initSingleton();
77
+ }
78
+ const rpcServer = createNamespacedSafeJsonRpcServer(services, {
79
+ diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
80
+ http200OnError: false,
81
+ log: debugLogger,
82
+ middlewares: [
83
+ getOtelJsonRpcServerMetricsMiddleware(),
84
+ getOtelJsonRpcPropagationMiddleware(),
85
+ getVersioningMiddleware(versions, versioningOpts)
86
+ ],
87
+ maxBatchSize: options.rpcMaxBatchSize,
88
+ maxBodySizeBytes: options.rpcMaxBodySize,
89
+ corsAllowedHeaders: options.rpcCorsAllowedHeaders,
90
+ corsAllowedOrigins: getRpcCorsAllowedOrigins(options)
91
+ });
92
+ const { port } = await startHttpRpcServer(rpcServer, {
93
+ port: options.port,
94
+ keepAliveTimeoutMs: options.rpcHttpKeepAliveTimeoutMs,
95
+ headersTimeoutMs: options.rpcHttpHeadersTimeoutMs
96
+ });
97
+ debugLogger.info(`Aztec Server listening on port ${port}`, versions);
98
+ }
99
+ // If there are any admin services, start a separate JSON-RPC server for them
100
+ if (Object.entries(adminServices).length > 0) {
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
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
110
+ }
111
+ const adminMiddlewares = [
112
+ getOtelJsonRpcServerMetricsMiddleware(),
113
+ ...apiKeyResolution ? [
114
+ getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash)
115
+ ] : [],
116
+ getOtelJsonRpcPropagationMiddleware(),
117
+ getVersioningMiddleware(versions, versioningOpts)
118
+ ];
119
+ const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
120
+ diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
121
+ http200OnError: false,
122
+ log: debugLogger,
123
+ middlewares: adminMiddlewares,
124
+ maxBatchSize: options.rpcMaxBatchSize,
125
+ maxBodySizeBytes: options.rpcMaxBodySize
126
+ });
127
+ const { port } = await startHttpRpcServer(rpcServer, {
128
+ port: options.adminPort
129
+ });
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
+ }
152
+ }
153
+ }
@@ -0,0 +1,17 @@
1
+ import { type ConfigMapping, type EnvVar } from '@aztec-labs/foundation/config';
2
+ export interface AztecStartOption {
3
+ flag: string;
4
+ description: string;
5
+ defaultValue: any;
6
+ printDefault?: (val: any) => string;
7
+ env: EnvVar | undefined;
8
+ fallback?: EnvVar[];
9
+ parseVal?: (val: string) => any;
10
+ }
11
+ export declare const getOptions: (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => AztecStartOption[];
12
+ export declare const universalOptions: string[];
13
+ export declare const NETWORK_FLAG = "network";
14
+ export declare const aztecStartOptions: {
15
+ [key: string]: AztecStartOption[];
16
+ };
17
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfb3B0aW9ucy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9henRlY19zdGFydF9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFDTCxLQUFLLGFBQWEsRUFDbEIsS0FBSyxNQUFNLEVBSVosTUFBTSwrQkFBK0IsQ0FBQztBQWV2QyxNQUFNLFdBQVcsZ0JBQWdCO0lBQy9CLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYixXQUFXLEVBQUUsTUFBTSxDQUFDO0lBQ3BCLFlBQVksRUFBRSxHQUFHLENBQUM7SUFDbEIsWUFBWSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLE1BQU0sQ0FBQztJQUNwQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUN4QixRQUFRLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNwQixRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssR0FBRyxDQUFDO0NBQ2pDO0FBRUQsZUFBTyxNQUFNLFVBQVUsbUdBb0J0QixDQUFDO0FBMkJGLGVBQU8sTUFBTSxnQkFBZ0IsVUFZNUIsQ0FBQztBQUVGLGVBQU8sTUFBTSxZQUFZLFlBQVksQ0FBQztBQUd0QyxlQUFPLE1BQU0saUJBQWlCLEVBQUU7SUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQTtDQXNPbEUsQ0FBQyJ9
@@ -0,0 +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,+BAA+B,CAAC;AAevC,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,mGAoBtB,CAAC;AA2BF,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"}