@aztec/aztec 0.0.1-commit.b655e406 → 0.0.1-commit.b6e433891

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 (165) hide show
  1. package/README.md +1 -1
  2. package/dest/bin/index.d.ts +1 -1
  3. package/dest/bin/index.js +13 -6
  4. package/dest/cli/admin_api_key_store.d.ts +45 -0
  5. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  6. package/dest/cli/admin_api_key_store.js +98 -0
  7. package/dest/cli/aztec_start_action.d.ts +1 -1
  8. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  9. package/dest/cli/aztec_start_action.js +72 -26
  10. package/dest/cli/aztec_start_options.d.ts +1 -1
  11. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  12. package/dest/cli/aztec_start_options.js +48 -41
  13. package/dest/cli/cli.d.ts +1 -1
  14. package/dest/cli/cli.js +7 -7
  15. package/dest/cli/cmds/compile.d.ts +4 -0
  16. package/dest/cli/cmds/compile.d.ts.map +1 -0
  17. package/dest/cli/cmds/compile.js +166 -0
  18. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  19. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  20. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  21. package/dest/cli/cmds/profile.d.ts +4 -0
  22. package/dest/cli/cmds/profile.d.ts.map +1 -0
  23. package/dest/cli/cmds/profile.js +8 -0
  24. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  25. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  26. package/dest/cli/cmds/profile_flamegraph.js +52 -0
  27. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  28. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  29. package/dest/cli/cmds/profile_gates.js +58 -0
  30. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  31. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  32. package/dest/cli/cmds/profile_utils.js +50 -0
  33. package/dest/cli/cmds/standby.d.ts +32 -0
  34. package/dest/cli/cmds/standby.d.ts.map +1 -0
  35. package/dest/cli/cmds/standby.js +97 -0
  36. package/dest/cli/cmds/start_archiver.d.ts +2 -2
  37. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  38. package/dest/cli/cmds/start_archiver.js +12 -14
  39. package/dest/cli/cmds/start_bot.d.ts +3 -3
  40. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  41. package/dest/cli/cmds/start_bot.js +10 -6
  42. package/dest/cli/cmds/start_node.d.ts +3 -2
  43. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  44. package/dest/cli/cmds/start_node.js +87 -31
  45. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  46. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  47. package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
  48. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  49. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  50. package/dest/cli/cmds/start_prover_agent.js +4 -4
  51. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  52. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  53. package/dest/cli/cmds/start_prover_broker.js +15 -9
  54. package/dest/cli/cmds/start_txe.d.ts +1 -1
  55. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  56. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  57. package/dest/cli/cmds/utils/artifacts.js +24 -0
  58. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  59. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  60. package/dest/cli/cmds/utils/needs_recompile.js +134 -0
  61. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  62. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  63. package/dest/cli/cmds/utils/spawn.js +16 -0
  64. package/dest/cli/index.d.ts +1 -1
  65. package/dest/cli/preload_crs.d.ts +1 -1
  66. package/dest/cli/util.d.ts +12 -23
  67. package/dest/cli/util.d.ts.map +1 -1
  68. package/dest/cli/util.js +51 -87
  69. package/dest/cli/versioning.d.ts +1 -1
  70. package/dest/examples/token.d.ts +1 -1
  71. package/dest/examples/token.js +10 -10
  72. package/dest/examples/util.d.ts +2 -2
  73. package/dest/examples/util.d.ts.map +1 -1
  74. package/dest/index.d.ts +2 -2
  75. package/dest/index.d.ts.map +1 -1
  76. package/dest/index.js +1 -1
  77. package/dest/local-network/banana_fpc.d.ts +10 -0
  78. package/dest/local-network/banana_fpc.d.ts.map +1 -0
  79. package/dest/{sandbox → local-network}/banana_fpc.js +4 -4
  80. package/dest/local-network/index.d.ts +4 -0
  81. package/dest/local-network/index.d.ts.map +1 -0
  82. package/dest/{sandbox → local-network}/index.js +1 -1
  83. package/dest/local-network/local-network.d.ts +73 -0
  84. package/dest/local-network/local-network.d.ts.map +1 -0
  85. package/dest/{sandbox/sandbox.js → local-network/local-network.js} +93 -50
  86. package/dest/local-network/sponsored_fpc.d.ts +5 -0
  87. package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
  88. package/dest/mnemonic.d.ts +1 -1
  89. package/dest/splash.d.ts +1 -1
  90. package/dest/testing/anvil_test_watcher.d.ts +12 -4
  91. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  92. package/dest/testing/anvil_test_watcher.js +68 -29
  93. package/dest/testing/cheat_codes.d.ts +1 -1
  94. package/dest/testing/cheat_codes.d.ts.map +1 -1
  95. package/dest/testing/epoch_test_settler.d.ts +19 -0
  96. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  97. package/dest/testing/epoch_test_settler.js +61 -0
  98. package/dest/testing/index.d.ts +3 -1
  99. package/dest/testing/index.d.ts.map +1 -1
  100. package/dest/testing/index.js +2 -0
  101. package/dest/testing/token_allowed_setup.d.ts +7 -0
  102. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  103. package/dest/testing/token_allowed_setup.js +20 -0
  104. package/package.json +41 -37
  105. package/scripts/add_crate.sh +102 -0
  106. package/scripts/aztec.sh +69 -0
  107. package/scripts/init.sh +39 -0
  108. package/scripts/new.sh +83 -0
  109. package/scripts/setup_workspace.sh +68 -0
  110. package/src/bin/index.ts +14 -6
  111. package/src/cli/admin_api_key_store.ts +128 -0
  112. package/src/cli/aztec_start_action.ts +70 -21
  113. package/src/cli/aztec_start_options.ts +49 -39
  114. package/src/cli/cli.ts +11 -11
  115. package/src/cli/cmds/compile.ts +191 -0
  116. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  117. package/src/cli/cmds/profile.ts +25 -0
  118. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  119. package/src/cli/cmds/profile_gates.ts +68 -0
  120. package/src/cli/cmds/profile_utils.ts +58 -0
  121. package/src/cli/cmds/standby.ts +132 -0
  122. package/src/cli/cmds/start_archiver.ts +8 -19
  123. package/src/cli/cmds/start_bot.ts +9 -6
  124. package/src/cli/cmds/start_node.ts +87 -37
  125. package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
  126. package/src/cli/cmds/start_prover_agent.ts +4 -12
  127. package/src/cli/cmds/start_prover_broker.ts +20 -16
  128. package/src/cli/cmds/utils/artifacts.ts +44 -0
  129. package/src/cli/cmds/utils/needs_recompile.ts +151 -0
  130. package/src/cli/cmds/utils/spawn.ts +16 -0
  131. package/src/cli/util.ts +60 -98
  132. package/src/examples/token.ts +11 -11
  133. package/src/examples/util.ts +1 -1
  134. package/src/index.ts +2 -2
  135. package/src/{sandbox → local-network}/banana_fpc.ts +12 -8
  136. package/src/{sandbox → local-network}/index.ts +1 -1
  137. package/src/local-network/local-network.ts +277 -0
  138. package/src/{sandbox → local-network}/sponsored_fpc.ts +3 -2
  139. package/src/testing/anvil_test_watcher.ts +76 -30
  140. package/src/testing/cheat_codes.ts +3 -2
  141. package/src/testing/epoch_test_settler.ts +70 -0
  142. package/src/testing/index.ts +2 -0
  143. package/src/testing/token_allowed_setup.ts +19 -0
  144. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  145. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  146. package/dest/cli/cmds/start_blob_sink.js +0 -33
  147. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  148. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  149. package/dest/cli/cmds/start_prover_node.js +0 -108
  150. package/dest/cli/release_version.d.ts +0 -2
  151. package/dest/cli/release_version.d.ts.map +0 -1
  152. package/dest/cli/release_version.js +0 -14
  153. package/dest/sandbox/banana_fpc.d.ts +0 -10
  154. package/dest/sandbox/banana_fpc.d.ts.map +0 -1
  155. package/dest/sandbox/index.d.ts +0 -4
  156. package/dest/sandbox/index.d.ts.map +0 -1
  157. package/dest/sandbox/sandbox.d.ts +0 -74
  158. package/dest/sandbox/sandbox.d.ts.map +0 -1
  159. package/dest/sandbox/sponsored_fpc.d.ts +0 -4
  160. package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
  161. package/src/cli/cmds/start_blob_sink.ts +0 -57
  162. package/src/cli/cmds/start_prover_node.ts +0 -124
  163. package/src/cli/release_version.ts +0 -21
  164. package/src/sandbox/sandbox.ts +0 -242
  165. /package/dest/{sandbox → local-network}/sponsored_fpc.js +0 -0
@@ -1,17 +1,20 @@
1
+ import { getActiveNetworkName } from '@aztec/foundation/config';
1
2
  import {
2
3
  type NamespacedApiHandlers,
3
4
  createNamespacedSafeJsonRpcServer,
5
+ getApiKeyAuthMiddleware,
4
6
  startHttpRpcServer,
5
7
  } from '@aztec/foundation/json-rpc/server';
6
8
  import type { LogFn, Logger } from '@aztec/foundation/log';
7
9
  import type { ChainConfig } from '@aztec/stdlib/config';
8
- import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
10
+ import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
11
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
9
12
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
10
13
  import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
14
 
12
- import { createSandbox } from '../sandbox/index.js';
15
+ import { createLocalNetwork } from '../local-network/index.js';
13
16
  import { github, splash } from '../splash.js';
14
- import { getCliVersion } from './release_version.js';
17
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
15
18
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
16
19
  import { getVersions } from './versioning.js';
17
20
 
@@ -20,22 +23,26 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
20
23
  const signalHandlers: Array<() => Promise<void>> = [];
21
24
  const services: NamespacedApiHandlers = {};
22
25
  const adminServices: NamespacedApiHandlers = {};
26
+ const packageVersion = getPackageVersion();
23
27
  let config: ChainConfig | undefined = undefined;
24
28
 
25
- if (options.sandbox) {
26
- const cliVersion = getCliVersion();
27
- const sandboxOptions = extractNamespacedOptions(options, 'sandbox');
28
- sandboxOptions.testAccounts = true;
29
+ if (options.localNetwork) {
30
+ const localNetwork = extractNamespacedOptions(options, 'local-network');
31
+ localNetwork.testAccounts = true;
29
32
  userLog(`${splash}\n${github}\n\n`);
30
- userLog(`Setting up Aztec Sandbox ${cliVersion}, please stand by...`);
33
+ userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
31
34
 
32
- const { node, stop } = await createSandbox(
35
+ const { node, stop } = await createLocalNetwork(
33
36
  {
34
- l1Mnemonic: sandboxOptions.l1Mnemonic,
37
+ l1Mnemonic: localNetwork.l1Mnemonic,
35
38
  l1RpcUrls: options.l1RpcUrls,
36
- deployAztecContractsSalt: sandboxOptions.deployAztecContractsSalt,
37
- testAccounts: sandboxOptions.testAccounts,
39
+ testAccounts: localNetwork.testAccounts,
38
40
  realProofs: false,
41
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
42
+ // the users can consume out hash without having to wait for a long time.
43
+ // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
44
+ // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
45
+ aztecEpochDuration: 2,
39
46
  },
40
47
  userLog,
41
48
  );
@@ -43,19 +50,20 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
43
50
  // Start Node and PXE JSON-RPC server
44
51
  signalHandlers.push(stop);
45
52
  services.node = [node, AztecNodeApiSchema];
53
+ adminServices.node = [node, AztecNodeAdminApiSchema];
46
54
  } else {
55
+ // Route --prover-node through startNode
56
+ if (options.proverNode && !options.node) {
57
+ options.node = true;
58
+ }
59
+
47
60
  if (options.node) {
48
61
  const { startNode } = await import('./cmds/start_node.js');
49
- ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
62
+ const networkName = getActiveNetworkName(options.network);
63
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
50
64
  } else if (options.bot) {
51
65
  const { startBot } = await import('./cmds/start_bot.js');
52
66
  await startBot(options, signalHandlers, services, userLog);
53
- } else if (options.proverNode) {
54
- const { startProverNode } = await import('./cmds/start_prover_node.js');
55
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
56
- } else if (options.blobSink) {
57
- const { startBlobSink } = await import('./cmds/start_blob_sink.js');
58
- await startBlobSink(options, signalHandlers, userLog);
59
67
  } else if (options.archiver) {
60
68
  const { startArchiver } = await import('./cmds/start_archiver.js');
61
69
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -82,13 +90,14 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
82
90
 
83
91
  installSignalHandlers(debugLogger.info, signalHandlers);
84
92
  const versions = getVersions(config);
93
+ const versioningOpts = { packageVersion };
85
94
 
86
95
  // Start the main JSON-RPC server
87
96
  if (Object.entries(services).length > 0) {
88
97
  const rpcServer = createNamespacedSafeJsonRpcServer(services, {
89
98
  http200OnError: false,
90
99
  log: debugLogger,
91
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
100
+ middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
92
101
  maxBatchSize: options.rpcMaxBatchSize,
93
102
  maxBodySizeBytes: options.rpcMaxBodySize,
94
103
  });
@@ -98,14 +107,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
98
107
 
99
108
  // If there are any admin services, start a separate JSON-RPC server for them
100
109
  if (Object.entries(adminServices).length > 0) {
110
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
111
+
112
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
113
+ const apiKeyResolution = await resolveAdminApiKey(
114
+ {
115
+ adminApiKeyHash: options.adminApiKeyHash,
116
+ disableAdminApiKey: options.disableAdminApiKey,
117
+ resetAdminApiKey: options.resetAdminApiKey,
118
+ dataDirectory: options.dataDirectory,
119
+ },
120
+ debugLogger,
121
+ );
122
+ if (apiKeyResolution) {
123
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
124
+ } else {
125
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
126
+ }
127
+
101
128
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
102
129
  http200OnError: false,
103
130
  log: debugLogger,
104
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
131
+ middlewares: adminMiddlewares,
105
132
  maxBatchSize: options.rpcMaxBatchSize,
106
133
  maxBodySizeBytes: options.rpcMaxBodySize,
107
134
  });
108
135
  const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
109
136
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
137
+
138
+ // Display the API key after the server has started
139
+ // Uses userLog which is never filtered by LOG_LEVEL.
140
+ if (apiKeyResolution?.rawKey) {
141
+ const separator = '='.repeat(70);
142
+ userLog('');
143
+ userLog(separator);
144
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
145
+ userLog('');
146
+ userLog(` ${apiKeyResolution.rawKey}`);
147
+ userLog('');
148
+ userLog(` Use via header: x-api-key: <key>`);
149
+ userLog(` Or via header: Authorization: Bearer <key>`);
150
+ if (options.dataDirectory) {
151
+ userLog('');
152
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
153
+ }
154
+ userLog('');
155
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
156
+ userLog(separator);
157
+ userLog('');
158
+ }
110
159
  }
111
160
  }
@@ -1,8 +1,9 @@
1
1
  import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
2
- import { sequencerClientConfigMappings } from '@aztec/aztec-node/config';
3
- import { blobSinkConfigMappings } from '@aztec/blob-sink/server';
2
+ import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
4
3
  import { botConfigMappings } from '@aztec/bot/config';
5
- import { l1ContractAddressesMapping, l1ContractsConfigMappings, l1ReaderConfigMappings } from '@aztec/ethereum';
4
+ import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
5
+ import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
6
+ import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
6
7
  import { getKeys } from '@aztec/foundation/collection';
7
8
  import {
8
9
  type ConfigMapping,
@@ -11,15 +12,16 @@ import {
11
12
  isBooleanConfigValue,
12
13
  omitConfigMappings,
13
14
  } from '@aztec/foundation/config';
14
- import { dataConfigMappings } from '@aztec/kv-store/config';
15
15
  import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
16
16
  import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
17
- import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
17
+ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
18
18
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
19
19
  import { allPxeConfigMappings } from '@aztec/pxe/config';
20
- import { chainConfigMappings } from '@aztec/stdlib/config';
21
- import { telemetryClientConfigMappings } from '@aztec/telemetry-client';
22
- import { worldStateConfigMappings } from '@aztec/world-state';
20
+ import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
21
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
22
+ import { dataConfigMappings } from '@aztec/stdlib/kv-store';
23
+ import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
24
+ import { worldStateConfigMappings } from '@aztec/world-state/config';
23
25
 
24
26
  import { DefaultMnemonic } from '../mnemonic.js';
25
27
 
@@ -82,6 +84,7 @@ export const universalOptions = [
82
84
  'l1ConsensusHostApiKeys',
83
85
  'l1ConsensusHostApiKeyHeaders',
84
86
  'p2pEnabled',
87
+ 'fishermanMode',
85
88
  ...getKeys(chainConfigMappings),
86
89
  ...getKeys(l1ContractsConfigMappings),
87
90
  ...getKeys(l1ContractAddressesMapping),
@@ -102,33 +105,26 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
102
105
  env: 'NETWORK',
103
106
  },
104
107
 
105
- configToFlag('--auto-update', sharedNodeConfigMappings.autoUpdate),
106
- configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
108
+ configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
107
109
 
108
110
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
109
111
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
112
+
113
+ configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode),
110
114
  ],
111
- SANDBOX: [
115
+ LOCAL_NETWORK: [
112
116
  {
113
- flag: '--sandbox',
114
- description: 'Starts Aztec Sandbox',
117
+ flag: '--local-network',
118
+ description: 'Starts Aztec Local Network',
115
119
  defaultValue: undefined,
116
120
  env: undefined,
117
121
  },
118
122
  {
119
- flag: '--sandbox.l1Mnemonic <value>',
123
+ flag: '--local-network.l1Mnemonic <value>',
120
124
  description: 'Mnemonic for L1 accounts. Will be used ',
121
125
  defaultValue: DefaultMnemonic,
122
126
  env: 'MNEMONIC',
123
127
  },
124
- {
125
- flag: '--sandbox.deployAztecContractsSalt <value>',
126
- description:
127
- 'Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set.',
128
- env: 'DEPLOY_AZTEC_CONTRACTS_SALT',
129
- defaultValue: undefined,
130
- parseVal: (val: string) => (val ? parseInt(val) : undefined),
131
- },
132
128
  ],
133
129
  API: [
134
130
  {
@@ -145,20 +141,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
145
141
  env: 'AZTEC_ADMIN_PORT',
146
142
  parseVal: val => parseInt(val, 10),
147
143
  },
144
+ {
145
+ flag: '--admin-api-key-hash <value>',
146
+ description:
147
+ 'SHA-256 hex hash of a pre-generated admin API key. When set, the node uses this hash for authentication instead of auto-generating a key.',
148
+ defaultValue: undefined,
149
+ env: 'AZTEC_ADMIN_API_KEY_HASH',
150
+ },
151
+ {
152
+ flag: '--disable-admin-api-key',
153
+ description:
154
+ 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
155
+ defaultValue: false,
156
+ env: 'AZTEC_DISABLE_ADMIN_API_KEY',
157
+ // undefined means the flag was passed without a value (boolean toggle), treat as true.
158
+ parseVal: val => val === undefined || val === 'true' || val === '1',
159
+ },
160
+ {
161
+ flag: '--reset-admin-api-key',
162
+ description:
163
+ 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
164
+ defaultValue: false,
165
+ env: 'AZTEC_RESET_ADMIN_API_KEY',
166
+ parseVal: val => val === 'true' || val === '1',
167
+ },
148
168
  {
149
169
  flag: '--api-prefix <value>',
150
170
  description: 'Prefix for API routes on any service that is started',
151
171
  defaultValue: '',
152
172
  env: 'API_PREFIX',
153
173
  },
174
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
175
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
154
176
  ],
155
177
  ETHEREUM: [
156
178
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
157
179
  // Do not set default for CLI: keep undefined unless provided via flag or env
158
180
  configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
159
- configToFlag('--l1-consensus-host-urls', blobSinkConfigMappings.l1ConsensusHostUrls),
160
- configToFlag('--l1-consensus-host-api-keys', blobSinkConfigMappings.l1ConsensusHostApiKeys),
161
- configToFlag('--l1-consensus-host-api-key-headers', blobSinkConfigMappings.l1ConsensusHostApiKeyHeaders),
181
+ configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
182
+ configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
183
+ configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
162
184
  ],
163
185
  'L1 CONTRACTS': [
164
186
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -171,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
171
193
  'WORLD STATE': [
172
194
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
173
195
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
174
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
196
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
175
197
  ],
176
198
  // We can't easily auto-generate node options as they're parts of modules defined below
177
199
  'AZTEC NODE': [
@@ -205,21 +227,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
205
227
  'sequencer',
206
228
  omitConfigMappings(sequencerClientConfigMappings, [
207
229
  'fakeProcessingDelayPerTxMs',
230
+ 'fakeThrowAfterProcessingTxCount',
208
231
  'skipCollectingAttestations',
209
232
  'skipInvalidateBlockAsProposer',
210
233
  'blobSinkMapSizeKb',
211
234
  ]),
212
235
  ),
213
236
  ],
214
- 'BLOB SINK': [
215
- {
216
- flag: '--blob-sink',
217
- description: 'Starts Aztec Blob Sink with options',
218
- defaultValue: undefined,
219
- env: undefined,
220
- },
221
- ...getOptions('blobSink', blobSinkConfigMappings),
222
- ],
223
237
  'PROVER NODE': [
224
238
  {
225
239
  flag: '--prover-node',
@@ -231,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
231
245
  'proverNode',
232
246
  omitConfigMappings(proverNodeConfigMappings, [
233
247
  // filter out options passed separately
234
- ...getKeys(archiverConfigMappings),
235
248
  ...getKeys(proverBrokerConfigMappings),
236
249
  ...getKeys(proverAgentConfigMappings),
237
- ...getKeys(p2pConfigMappings),
238
- ...getKeys(worldStateConfigMappings),
239
- ...getKeys(sharedNodeConfigMappings),
240
250
  ]),
241
251
  ),
242
252
  ],
package/src/cli/cli.ts CHANGED
@@ -31,18 +31,18 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
31
31
 
32
32
  program.configureHelp({ sortSubcommands: true });
33
33
 
34
- program.addHelpText(
35
- 'after',
36
- `
37
-
38
- Additional commands:
39
-
40
- test [options]: starts a dockerized TXE node via
41
- $ aztec start --txe
42
- then runs
43
- $ aztec-nargo test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
34
+ if (process.env.AZTEC_SHELL_WRAPPER) {
35
+ program.addHelpText(
36
+ 'after',
37
+ `
38
+ Additional commands:
39
+
40
+ init creates a new Aztec Noir workspace in the current directory.
41
+ new <name> creates a new Aztec Noir workspace in its own directory (or creates a new contract-test crates pair and adds it to the current workspace if run in workspace).
42
+ test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
44
43
  `,
45
- );
44
+ );
45
+ }
46
46
 
47
47
  program
48
48
  .command('preload-crs')
@@ -0,0 +1,191 @@
1
+ import { findBbBinary } from '@aztec/bb.js';
2
+ import type { LogFn } from '@aztec/foundation/log';
3
+
4
+ import { execFileSync } from 'child_process';
5
+ import type { Command } from 'commander';
6
+ import { readFile, writeFile } from 'fs/promises';
7
+ import { join } from 'path';
8
+
9
+ import { readArtifactFiles } from './utils/artifacts.js';
10
+ import { needsRecompile } from './utils/needs_recompile.js';
11
+ import { run } from './utils/spawn.js';
12
+
13
+ /** Returns paths to contract artifacts in the target directory. */
14
+ async function collectContractArtifacts(): Promise<string[]> {
15
+ let files;
16
+ try {
17
+ files = await readArtifactFiles('target');
18
+ } catch (err: any) {
19
+ if (err?.message?.includes('does not exist')) {
20
+ return [];
21
+ }
22
+ throw err;
23
+ }
24
+ return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
25
+ }
26
+
27
+ /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
28
+ async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
29
+ for (const path of artifactPaths) {
30
+ const artifact = JSON.parse(await readFile(path, 'utf-8'));
31
+ for (const fn of artifact.functions) {
32
+ if (typeof fn.name === 'string') {
33
+ fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
34
+ }
35
+ }
36
+ await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
37
+ }
38
+ }
39
+
40
+ /** Returns the set of package names that are contract crates in the current workspace. */
41
+ async function getContractPackageNames(): Promise<Set<string>> {
42
+ const contractNames = new Set<string>();
43
+
44
+ let rootToml: string;
45
+ try {
46
+ rootToml = await readFile('Nargo.toml', 'utf-8');
47
+ } catch {
48
+ return contractNames;
49
+ }
50
+
51
+ const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
52
+ if (membersMatch) {
53
+ const members = membersMatch[1]
54
+ .split(',')
55
+ .map(m => m.trim().replace(/^"|"$/g, ''))
56
+ .filter(m => m.length > 0);
57
+
58
+ for (const member of members) {
59
+ try {
60
+ const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
61
+ if (/type\s*=\s*"contract"/.test(memberToml)) {
62
+ const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
63
+ if (nameMatch) {
64
+ contractNames.add(nameMatch[1]);
65
+ }
66
+ }
67
+ } catch {
68
+ // Member directory might not exist or have no Nargo.toml; skip.
69
+ }
70
+ }
71
+ } else {
72
+ // Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
73
+ if (/type\s*=\s*"contract"/.test(rootToml)) {
74
+ const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
75
+ if (nameMatch) {
76
+ contractNames.add(nameMatch[1]);
77
+ }
78
+ }
79
+ }
80
+
81
+ return contractNames;
82
+ }
83
+
84
+ /** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
85
+ async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
86
+ const contractPackages = await getContractPackageNames();
87
+ if (contractPackages.size === 0) {
88
+ return;
89
+ }
90
+
91
+ let output: string;
92
+ try {
93
+ // We list tests for all the crates in the workspace
94
+ output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
95
+ encoding: 'utf-8',
96
+ stdio: ['pipe', 'pipe', 'inherit'],
97
+ });
98
+ } catch {
99
+ // If listing tests fails (e.g. test crate has compile errors), skip the check.
100
+ return;
101
+ }
102
+
103
+ // The output of the `nargo test --list-tests` command is as follows:
104
+ // ```
105
+ // crate_name_1 test_name_1
106
+ // crate_name_2 test_name_2
107
+ // ...
108
+ // crate_name_n test_name_n
109
+ // ```
110
+ //
111
+ // We parse the individual lines and then we check if any contract crate appeared in the parsed output.
112
+ const lines = output
113
+ .trim()
114
+ .split('\n')
115
+ .filter(line => line.length > 0);
116
+ const testsInContracts: { packageName: string; testName: string }[] = [];
117
+
118
+ for (const line of lines) {
119
+ const spaceIndex = line.indexOf(' ');
120
+ if (spaceIndex === -1) {
121
+ continue;
122
+ }
123
+ const packageName = line.substring(0, spaceIndex);
124
+ const testName = line.substring(spaceIndex + 1);
125
+ if (contractPackages.has(packageName)) {
126
+ testsInContracts.push({ packageName, testName });
127
+ }
128
+ }
129
+
130
+ if (testsInContracts.length > 0) {
131
+ const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
132
+ log(
133
+ `WARNING: Found tests in contract crate(s):\n${details}\n\n` +
134
+ `Tests should be in a dedicated test crate, not in the contract crate.\n` +
135
+ `Learn more: https://docs.aztec.network/errors/1`,
136
+ );
137
+ }
138
+ }
139
+
140
+ /** Compiles Aztec Noir contracts and postprocesses artifacts. */
141
+ async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
142
+ if (!(await needsRecompile())) {
143
+ log('No source changes detected, skipping compilation.');
144
+ return;
145
+ }
146
+
147
+ const nargo = process.env.NARGO ?? 'nargo';
148
+ const bb = process.env.BB ?? findBbBinary() ?? 'bb';
149
+
150
+ await run(nargo, ['compile', ...nargoArgs]);
151
+
152
+ // Ensure contract crates contain no tests (tests belong in the test crate).
153
+ await checkNoTestsInContracts(nargo, log);
154
+
155
+ const artifacts = await collectContractArtifacts();
156
+
157
+ if (artifacts.length > 0) {
158
+ log('Postprocessing contracts...');
159
+ const bbArgs = artifacts.flatMap(a => ['-i', a]);
160
+ await run(bb, ['aztec_process', ...bbArgs]);
161
+
162
+ // TODO: This should be part of bb aztec_process!
163
+ await stripInternalPrefixes(artifacts);
164
+ }
165
+
166
+ log('Compilation complete!');
167
+ }
168
+
169
+ export function injectCompileCommand(program: Command, log: LogFn): Command {
170
+ program
171
+ .command('compile')
172
+ .argument('[nargo-args...]')
173
+ .passThroughOptions()
174
+ .allowUnknownOption()
175
+ .description(
176
+ 'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
177
+ )
178
+ .addHelpText('after', () => {
179
+ // Show nargo's own compile options so users see all available flags in one place.
180
+ const nargo = process.env.NARGO ?? 'nargo';
181
+ try {
182
+ const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
183
+ return `\nUnderlying nargo compile options:\n\n${output}`;
184
+ } catch {
185
+ return '\n(Run "nargo compile --help" to see available nargo options)';
186
+ }
187
+ })
188
+ .action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
189
+
190
+ return program;
191
+ }
@@ -0,0 +1,43 @@
1
+ import { runMigrations } from '@aztec/validator-ha-signer/migrations';
2
+
3
+ import type { Command } from 'commander';
4
+
5
+ export function injectMigrateCommand(program: Command, log: (msg: string) => void): Command {
6
+ const migrateCommand = program.command('migrate-ha-db').description('Run validator-ha-signer database migrations');
7
+
8
+ migrateCommand
9
+ .command('up')
10
+ .description('Apply pending migrations')
11
+ .requiredOption('--database-url <string>', 'PostgreSQL connection string', process.env.DATABASE_URL)
12
+ .option('--verbose', 'Enable verbose output', false)
13
+ .action(async options => {
14
+ const migrations = await runMigrations(options.databaseUrl, {
15
+ direction: 'up',
16
+ verbose: options.verbose,
17
+ });
18
+ if (migrations.length > 0) {
19
+ log(`Applied migrations: ${migrations.join(', ')}`);
20
+ } else {
21
+ log('No migrations to apply - schema is up to date');
22
+ }
23
+ });
24
+
25
+ migrateCommand
26
+ .command('down')
27
+ .description('Rollback the last migration')
28
+ .requiredOption('--database-url <string>', 'PostgreSQL connection string', process.env.DATABASE_URL)
29
+ .option('--verbose', 'Enable verbose output', false)
30
+ .action(async options => {
31
+ const migrations = await runMigrations(options.databaseUrl, {
32
+ direction: 'down',
33
+ verbose: options.verbose,
34
+ });
35
+ if (migrations.length > 0) {
36
+ log(`Rolled back migrations: ${migrations.join(', ')}`);
37
+ } else {
38
+ log('No migrations to rollback');
39
+ }
40
+ });
41
+
42
+ return program;
43
+ }
@@ -0,0 +1,25 @@
1
+ import type { LogFn } from '@aztec/foundation/log';
2
+
3
+ import type { Command } from 'commander';
4
+
5
+ import { profileFlamegraph } from './profile_flamegraph.js';
6
+ import { profileGates } from './profile_gates.js';
7
+
8
+ export function injectProfileCommand(program: Command, log: LogFn): Command {
9
+ const profile = program.command('profile').description('Profile compiled Aztec artifacts.');
10
+
11
+ profile
12
+ .command('gates')
13
+ .argument('[target-dir]', 'Path to the compiled artifacts directory', './target')
14
+ .description('Display gate counts for all compiled Aztec artifacts in a target directory.')
15
+ .action((targetDir: string) => profileGates(targetDir, log));
16
+
17
+ profile
18
+ .command('flamegraph')
19
+ .argument('<contract-artifact>', 'Path to the compiled contract artifact JSON')
20
+ .argument('<function>', 'Name of the contract function to profile')
21
+ .description('Generate a gate count flamegraph SVG for a contract function.')
22
+ .action((artifactPath: string, functionName: string) => profileFlamegraph(artifactPath, functionName, log));
23
+
24
+ return program;
25
+ }