@aztec/aztec 0.0.1-commit.9593d84 → 0.0.1-commit.96dac018d

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 (123) hide show
  1. package/dest/bin/index.js +10 -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 +50 -13
  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 +39 -33
  11. package/dest/cli/cli.d.ts +1 -1
  12. package/dest/cli/cli.d.ts.map +1 -1
  13. package/dest/cli/cli.js +4 -37
  14. package/dest/cli/cmds/compile.d.ts +4 -0
  15. package/dest/cli/cmds/compile.d.ts.map +1 -0
  16. package/dest/cli/cmds/compile.js +160 -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/start_archiver.d.ts +1 -1
  33. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  34. package/dest/cli/cmds/start_archiver.js +11 -13
  35. package/dest/cli/cmds/start_bot.d.ts +3 -3
  36. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_bot.js +10 -6
  38. package/dest/cli/cmds/start_node.d.ts +1 -1
  39. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  40. package/dest/cli/cmds/start_node.js +64 -12
  41. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  42. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  43. package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
  44. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  45. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  46. package/dest/cli/cmds/start_prover_agent.js +4 -4
  47. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  48. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  49. package/dest/cli/cmds/start_prover_broker.js +4 -4
  50. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  51. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  52. package/dest/cli/cmds/utils/artifacts.js +24 -0
  53. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  54. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  55. package/dest/cli/cmds/utils/spawn.js +16 -0
  56. package/dest/cli/util.d.ts +8 -17
  57. package/dest/cli/util.d.ts.map +1 -1
  58. package/dest/cli/util.js +13 -8
  59. package/dest/examples/token.js +5 -5
  60. package/dest/examples/util.d.ts +2 -2
  61. package/dest/examples/util.d.ts.map +1 -1
  62. package/dest/local-network/banana_fpc.d.ts +1 -1
  63. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  64. package/dest/local-network/banana_fpc.js +3 -3
  65. package/dest/local-network/local-network.d.ts +13 -14
  66. package/dest/local-network/local-network.d.ts.map +1 -1
  67. package/dest/local-network/local-network.js +68 -38
  68. package/dest/testing/anvil_test_watcher.d.ts +10 -2
  69. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  70. package/dest/testing/anvil_test_watcher.js +53 -16
  71. package/dest/testing/cheat_codes.d.ts +3 -1
  72. package/dest/testing/cheat_codes.d.ts.map +1 -1
  73. package/dest/testing/epoch_test_settler.d.ts +19 -0
  74. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  75. package/dest/testing/epoch_test_settler.js +62 -0
  76. package/dest/testing/index.d.ts +2 -1
  77. package/dest/testing/index.d.ts.map +1 -1
  78. package/dest/testing/index.js +1 -0
  79. package/package.json +37 -35
  80. package/scripts/aztec.sh +17 -11
  81. package/scripts/init.sh +23 -13
  82. package/scripts/new.sh +17 -16
  83. package/scripts/setup_workspace.sh +124 -0
  84. package/src/bin/index.ts +11 -3
  85. package/src/cli/admin_api_key_store.ts +128 -0
  86. package/src/cli/aztec_start_action.ts +53 -8
  87. package/src/cli/aztec_start_options.ts +40 -32
  88. package/src/cli/cli.ts +4 -37
  89. package/src/cli/cmds/compile.ts +184 -0
  90. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  91. package/src/cli/cmds/profile.ts +25 -0
  92. package/src/cli/cmds/profile_flamegraph.ts +63 -0
  93. package/src/cli/cmds/profile_gates.ts +67 -0
  94. package/src/cli/cmds/profile_utils.ts +58 -0
  95. package/src/cli/cmds/start_archiver.ts +7 -18
  96. package/src/cli/cmds/start_bot.ts +9 -6
  97. package/src/cli/cmds/start_node.ts +53 -11
  98. package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
  99. package/src/cli/cmds/start_prover_agent.ts +4 -12
  100. package/src/cli/cmds/start_prover_broker.ts +7 -3
  101. package/src/cli/cmds/utils/artifacts.ts +44 -0
  102. package/src/cli/cmds/utils/spawn.ts +16 -0
  103. package/src/cli/util.ts +20 -25
  104. package/src/examples/token.ts +5 -7
  105. package/src/examples/util.ts +1 -1
  106. package/src/local-network/banana_fpc.ts +11 -7
  107. package/src/local-network/local-network.ts +107 -82
  108. package/src/testing/anvil_test_watcher.ts +61 -17
  109. package/src/testing/cheat_codes.ts +3 -2
  110. package/src/testing/epoch_test_settler.ts +71 -0
  111. package/src/testing/index.ts +1 -0
  112. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  113. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  114. package/dest/cli/cmds/start_blob_sink.js +0 -33
  115. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  116. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  117. package/dest/cli/cmds/start_prover_node.js +0 -108
  118. package/scripts/compile.sh +0 -44
  119. package/scripts/extract_function.js +0 -47
  120. package/scripts/flamegraph.sh +0 -59
  121. package/scripts/setup_project.sh +0 -31
  122. package/src/cli/cmds/start_blob_sink.ts +0 -57
  123. package/src/cli/cmds/start_prover_node.ts +0 -124
@@ -1,6 +1,7 @@
1
1
  import {
2
2
  type NamespacedApiHandlers,
3
3
  createNamespacedSafeJsonRpcServer,
4
+ getApiKeyAuthMiddleware,
4
5
  startHttpRpcServer,
5
6
  } from '@aztec/foundation/json-rpc/server';
6
7
  import type { LogFn, Logger } from '@aztec/foundation/log';
@@ -11,6 +12,7 @@ import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
12
 
12
13
  import { createLocalNetwork } from '../local-network/index.js';
13
14
  import { github, splash } from '../splash.js';
15
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
14
16
  import { getCliVersion } from './release_version.js';
15
17
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
16
18
  import { getVersions } from './versioning.js';
@@ -33,9 +35,13 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
33
35
  {
34
36
  l1Mnemonic: localNetwork.l1Mnemonic,
35
37
  l1RpcUrls: options.l1RpcUrls,
36
- deployAztecContractsSalt: localNetwork.deployAztecContractsSalt,
37
38
  testAccounts: localNetwork.testAccounts,
38
39
  realProofs: false,
40
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
41
+ // the users can consume out hash without having to wait for a long time.
42
+ // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
43
+ // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
44
+ aztecEpochDuration: 2,
39
45
  },
40
46
  userLog,
41
47
  );
@@ -44,18 +50,17 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
44
50
  signalHandlers.push(stop);
45
51
  services.node = [node, AztecNodeApiSchema];
46
52
  } else {
53
+ // Route --prover-node through startNode
54
+ if (options.proverNode && !options.node) {
55
+ options.node = true;
56
+ }
57
+
47
58
  if (options.node) {
48
59
  const { startNode } = await import('./cmds/start_node.js');
49
60
  ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
50
61
  } else if (options.bot) {
51
62
  const { startBot } = await import('./cmds/start_bot.js');
52
63
  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
64
  } else if (options.archiver) {
60
65
  const { startArchiver } = await import('./cmds/start_archiver.js');
61
66
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -98,14 +103,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
98
103
 
99
104
  // If there are any admin services, start a separate JSON-RPC server for them
100
105
  if (Object.entries(adminServices).length > 0) {
106
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
107
+
108
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
109
+ const apiKeyResolution = await resolveAdminApiKey(
110
+ {
111
+ adminApiKeyHash: options.adminApiKeyHash,
112
+ disableAdminApiKey: options.disableAdminApiKey,
113
+ resetAdminApiKey: options.resetAdminApiKey,
114
+ dataDirectory: options.dataDirectory,
115
+ },
116
+ debugLogger,
117
+ );
118
+ if (apiKeyResolution) {
119
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
120
+ } else {
121
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
122
+ }
123
+
101
124
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
102
125
  http200OnError: false,
103
126
  log: debugLogger,
104
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
127
+ middlewares: adminMiddlewares,
105
128
  maxBatchSize: options.rpcMaxBatchSize,
106
129
  maxBodySizeBytes: options.rpcMaxBodySize,
107
130
  });
108
131
  const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
109
132
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
133
+
134
+ // Display the API key after the server has started
135
+ // Uses userLog which is never filtered by LOG_LEVEL.
136
+ if (apiKeyResolution?.rawKey) {
137
+ const separator = '='.repeat(70);
138
+ userLog('');
139
+ userLog(separator);
140
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
141
+ userLog('');
142
+ userLog(` ${apiKeyResolution.rawKey}`);
143
+ userLog('');
144
+ userLog(` Use via header: x-api-key: <key>`);
145
+ userLog(` Or via header: Authorization: Bearer <key>`);
146
+ if (options.dataDirectory) {
147
+ userLog('');
148
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
149
+ }
150
+ userLog('');
151
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
152
+ userLog(separator);
153
+ userLog('');
154
+ }
110
155
  }
111
156
  }
@@ -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,
@@ -14,12 +15,13 @@ import {
14
15
  import { dataConfigMappings } from '@aztec/kv-store/config';
15
16
  import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
16
17
  import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
17
- import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
18
+ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
18
19
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
19
20
  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';
21
+ import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
22
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
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
 
@@ -124,14 +126,6 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
124
126
  defaultValue: DefaultMnemonic,
125
127
  env: 'MNEMONIC',
126
128
  },
127
- {
128
- flag: '--local-network.deployAztecContractsSalt <value>',
129
- description:
130
- 'Numeric salt for deploying L1 Aztec contracts before starting the local network. Needs mnemonic or private key to be set.',
131
- env: 'DEPLOY_AZTEC_CONTRACTS_SALT',
132
- defaultValue: undefined,
133
- parseVal: (val: string) => (val ? parseInt(val) : undefined),
134
- },
135
129
  ],
136
130
  API: [
137
131
  {
@@ -148,20 +142,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
148
142
  env: 'AZTEC_ADMIN_PORT',
149
143
  parseVal: val => parseInt(val, 10),
150
144
  },
145
+ {
146
+ flag: '--admin-api-key-hash <value>',
147
+ description:
148
+ '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.',
149
+ defaultValue: undefined,
150
+ env: 'AZTEC_ADMIN_API_KEY_HASH',
151
+ },
152
+ {
153
+ flag: '--disable-admin-api-key',
154
+ description:
155
+ 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
156
+ defaultValue: false,
157
+ env: 'AZTEC_DISABLE_ADMIN_API_KEY',
158
+ // undefined means the flag was passed without a value (boolean toggle), treat as true.
159
+ parseVal: val => val === undefined || val === 'true' || val === '1',
160
+ },
161
+ {
162
+ flag: '--reset-admin-api-key',
163
+ description:
164
+ 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
165
+ defaultValue: false,
166
+ env: 'AZTEC_RESET_ADMIN_API_KEY',
167
+ parseVal: val => val === 'true' || val === '1',
168
+ },
151
169
  {
152
170
  flag: '--api-prefix <value>',
153
171
  description: 'Prefix for API routes on any service that is started',
154
172
  defaultValue: '',
155
173
  env: 'API_PREFIX',
156
174
  },
175
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
176
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
157
177
  ],
158
178
  ETHEREUM: [
159
179
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
160
180
  // Do not set default for CLI: keep undefined unless provided via flag or env
161
181
  configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
162
- configToFlag('--l1-consensus-host-urls', blobSinkConfigMappings.l1ConsensusHostUrls),
163
- configToFlag('--l1-consensus-host-api-keys', blobSinkConfigMappings.l1ConsensusHostApiKeys),
164
- configToFlag('--l1-consensus-host-api-key-headers', blobSinkConfigMappings.l1ConsensusHostApiKeyHeaders),
182
+ configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
183
+ configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
184
+ configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
165
185
  ],
166
186
  'L1 CONTRACTS': [
167
187
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -174,7 +194,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
174
194
  'WORLD STATE': [
175
195
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
176
196
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
177
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
197
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
178
198
  ],
179
199
  // We can't easily auto-generate node options as they're parts of modules defined below
180
200
  'AZTEC NODE': [
@@ -208,21 +228,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
208
228
  'sequencer',
209
229
  omitConfigMappings(sequencerClientConfigMappings, [
210
230
  'fakeProcessingDelayPerTxMs',
231
+ 'fakeThrowAfterProcessingTxCount',
211
232
  'skipCollectingAttestations',
212
233
  'skipInvalidateBlockAsProposer',
213
234
  'blobSinkMapSizeKb',
214
235
  ]),
215
236
  ),
216
237
  ],
217
- 'BLOB SINK': [
218
- {
219
- flag: '--blob-sink',
220
- description: 'Starts Aztec Blob Sink with options',
221
- defaultValue: undefined,
222
- env: undefined,
223
- },
224
- ...getOptions('blobSink', blobSinkConfigMappings),
225
- ],
226
238
  'PROVER NODE': [
227
239
  {
228
240
  flag: '--prover-node',
@@ -234,12 +246,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
234
246
  'proverNode',
235
247
  omitConfigMappings(proverNodeConfigMappings, [
236
248
  // filter out options passed separately
237
- ...getKeys(archiverConfigMappings),
238
249
  ...getKeys(proverBrokerConfigMappings),
239
250
  ...getKeys(proverAgentConfigMappings),
240
- ...getKeys(p2pConfigMappings),
241
- ...getKeys(worldStateConfigMappings),
242
- ...getKeys(sharedNodeConfigMappings),
243
251
  ]),
244
252
  ),
245
253
  ],
package/src/cli/cli.ts CHANGED
@@ -35,44 +35,11 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
35
35
  program.addHelpText(
36
36
  'after',
37
37
  `
38
+ Additional commands:
38
39
 
39
- Additional commands:
40
-
41
- init [folder] [options]: creates a new Noir project
42
- Options:
43
- --name <name> Name of the package
44
- --contract Use a contract template (default)
45
- --lib Use a library template
46
- --bin Use a binary template
47
- Examples:
48
- $ aztec init # creates a contract project in current directory
49
- $ aztec init --lib # creates a library project
50
-
51
- new <path> [options]: creates a new Noir project in a new directory
52
- Options:
53
- --name <name> Name of the package
54
- --contract Use a contract template (default)
55
- --lib Use a library template
56
- --bin Use a binary template
57
- Examples:
58
- $ aztec new my-project # creates a contract project in ./my-project
59
- $ aztec new my-lib --lib # creates a library project in ./my-lib
60
-
61
- compile [options]: compiles Aztec Noir contracts
62
- Compiles contracts with nargo compile and then postprocesses them to generate Aztec-specific artifacts including:
63
- - Transpiled contract artifacts
64
- - Verification keys
65
- The compiled contracts will be placed in the target/ directory by default.
66
- Supports standard nargo compile options.
67
-
68
- test [options]: starts a dockerized TXE node via
69
- $ aztec start --txe
70
- then runs
71
- $ aztec test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
72
-
73
- preload-crs: Downloads and caches the Common Reference String (CRS) data required for zero-knowledge proofs.
74
- Example:
75
- $ aztec preload-crs # preloads CRS data
40
+ init [folder] [options] creates a new Aztec Noir project.
41
+ new <path> [options] creates a new Aztec Noir project in a new directory.
42
+ test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
76
43
  `,
77
44
  );
78
45
  }
@@ -0,0 +1,184 @@
1
+ import type { LogFn } from '@aztec/foundation/log';
2
+
3
+ import { execFileSync } from 'child_process';
4
+ import type { Command } from 'commander';
5
+ import { readFile, writeFile } from 'fs/promises';
6
+ import { join } from 'path';
7
+
8
+ import { readArtifactFiles } from './utils/artifacts.js';
9
+ import { run } from './utils/spawn.js';
10
+
11
+ /** Returns paths to contract artifacts in the target directory. */
12
+ async function collectContractArtifacts(): Promise<string[]> {
13
+ let files;
14
+ try {
15
+ files = await readArtifactFiles('target');
16
+ } catch (err: any) {
17
+ if (err?.message?.includes('does not exist')) {
18
+ return [];
19
+ }
20
+ throw err;
21
+ }
22
+ return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
23
+ }
24
+
25
+ /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
26
+ async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
27
+ for (const path of artifactPaths) {
28
+ const artifact = JSON.parse(await readFile(path, 'utf-8'));
29
+ for (const fn of artifact.functions) {
30
+ if (typeof fn.name === 'string') {
31
+ fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
32
+ }
33
+ }
34
+ await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
35
+ }
36
+ }
37
+
38
+ /** Returns the set of package names that are contract crates in the current workspace. */
39
+ async function getContractPackageNames(): Promise<Set<string>> {
40
+ const contractNames = new Set<string>();
41
+
42
+ let rootToml: string;
43
+ try {
44
+ rootToml = await readFile('Nargo.toml', 'utf-8');
45
+ } catch {
46
+ return contractNames;
47
+ }
48
+
49
+ const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
50
+ if (membersMatch) {
51
+ const members = membersMatch[1]
52
+ .split(',')
53
+ .map(m => m.trim().replace(/^"|"$/g, ''))
54
+ .filter(m => m.length > 0);
55
+
56
+ for (const member of members) {
57
+ try {
58
+ const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
59
+ if (/type\s*=\s*"contract"/.test(memberToml)) {
60
+ const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
61
+ if (nameMatch) {
62
+ contractNames.add(nameMatch[1]);
63
+ }
64
+ }
65
+ } catch {
66
+ // Member directory might not exist or have no Nargo.toml; skip.
67
+ }
68
+ }
69
+ } else {
70
+ // Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
71
+ if (/type\s*=\s*"contract"/.test(rootToml)) {
72
+ const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
73
+ if (nameMatch) {
74
+ contractNames.add(nameMatch[1]);
75
+ }
76
+ }
77
+ }
78
+
79
+ return contractNames;
80
+ }
81
+
82
+ /** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
83
+ async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
84
+ const contractPackages = await getContractPackageNames();
85
+ if (contractPackages.size === 0) {
86
+ return;
87
+ }
88
+
89
+ let output: string;
90
+ try {
91
+ // We list tests for all the crates in the workspace
92
+ output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
93
+ encoding: 'utf-8',
94
+ stdio: ['pipe', 'pipe', 'inherit'],
95
+ });
96
+ } catch {
97
+ // If listing tests fails (e.g. test crate has compile errors), skip the check.
98
+ return;
99
+ }
100
+
101
+ // The output of the `nargo test --list-tests` command is as follows:
102
+ // ```
103
+ // crate_name_1 test_name_1
104
+ // crate_name_2 test_name_2
105
+ // ...
106
+ // crate_name_n test_name_n
107
+ // ```
108
+ //
109
+ // We parse the individual lines and then we check if any contract crate appeared in the parsed output.
110
+ const lines = output
111
+ .trim()
112
+ .split('\n')
113
+ .filter(line => line.length > 0);
114
+ const testsInContracts: { packageName: string; testName: string }[] = [];
115
+
116
+ for (const line of lines) {
117
+ const spaceIndex = line.indexOf(' ');
118
+ if (spaceIndex === -1) {
119
+ continue;
120
+ }
121
+ const packageName = line.substring(0, spaceIndex);
122
+ const testName = line.substring(spaceIndex + 1);
123
+ if (contractPackages.has(packageName)) {
124
+ testsInContracts.push({ packageName, testName });
125
+ }
126
+ }
127
+
128
+ if (testsInContracts.length > 0) {
129
+ const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
130
+ log(
131
+ `WARNING: Found tests in contract crate(s):\n${details}\n\n` +
132
+ `Tests should be in a dedicated test crate, not in the contract crate.\n` +
133
+ `Learn more: https://docs.aztec.network/errors/1`,
134
+ );
135
+ }
136
+ }
137
+
138
+ /** Compiles Aztec Noir contracts and postprocesses artifacts. */
139
+ async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
140
+ const nargo = process.env.NARGO ?? 'nargo';
141
+ const bb = process.env.BB ?? 'bb';
142
+
143
+ await run(nargo, ['compile', ...nargoArgs]);
144
+
145
+ // Ensure contract crates contain no tests (tests belong in the test crate).
146
+ await checkNoTestsInContracts(nargo, log);
147
+
148
+ const artifacts = await collectContractArtifacts();
149
+
150
+ if (artifacts.length > 0) {
151
+ log('Postprocessing contracts...');
152
+ const bbArgs = artifacts.flatMap(a => ['-i', a]);
153
+ await run(bb, ['aztec_process', ...bbArgs]);
154
+
155
+ // TODO: This should be part of bb aztec_process!
156
+ await stripInternalPrefixes(artifacts);
157
+ }
158
+
159
+ log('Compilation complete!');
160
+ }
161
+
162
+ export function injectCompileCommand(program: Command, log: LogFn): Command {
163
+ program
164
+ .command('compile')
165
+ .argument('[nargo-args...]')
166
+ .passThroughOptions()
167
+ .allowUnknownOption()
168
+ .description(
169
+ 'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
170
+ )
171
+ .addHelpText('after', () => {
172
+ // Show nargo's own compile options so users see all available flags in one place.
173
+ const nargo = process.env.NARGO ?? 'nargo';
174
+ try {
175
+ const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
176
+ return `\nUnderlying nargo compile options:\n\n${output}`;
177
+ } catch {
178
+ return '\n(Run "nargo compile --help" to see available nargo options)';
179
+ }
180
+ })
181
+ .action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
182
+
183
+ return program;
184
+ }
@@ -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
+ }
@@ -0,0 +1,63 @@
1
+ import type { LogFn } from '@aztec/foundation/log';
2
+
3
+ import { readFile, rename, rm, writeFile } from 'fs/promises';
4
+ import { basename, dirname, join } from 'path';
5
+
6
+ import { makeFunctionArtifact } from './profile_utils.js';
7
+ import type { CompiledArtifact } from './utils/artifacts.js';
8
+ import { run } from './utils/spawn.js';
9
+
10
+ /** Generates a gate count flamegraph SVG for a single contract function. */
11
+ export async function profileFlamegraph(artifactPath: string, functionName: string, log: LogFn): Promise<void> {
12
+ const raw = await readFile(artifactPath, 'utf-8');
13
+ const artifact: CompiledArtifact = JSON.parse(raw);
14
+
15
+ if (!Array.isArray(artifact.functions)) {
16
+ throw new Error(`${artifactPath} does not appear to be a contract artifact (no functions array)`);
17
+ }
18
+
19
+ const func = artifact.functions.find(f => f.name === functionName);
20
+ if (!func) {
21
+ const available = artifact.functions.map(f => f.name).join(', ');
22
+ throw new Error(`Function "${functionName}" not found in artifact. Available: ${available}`);
23
+ }
24
+ if (func.is_unconstrained) {
25
+ throw new Error(`Function "${functionName}" is unconstrained and cannot be profiled`);
26
+ }
27
+
28
+ const outputDir = dirname(artifactPath);
29
+ const contractName = basename(artifactPath, '.json');
30
+ const functionArtifact = join(outputDir, `${contractName}-${functionName}.json`);
31
+
32
+ try {
33
+ await writeFile(functionArtifact, makeFunctionArtifact(artifact, func));
34
+
35
+ const profiler = process.env.PROFILER_PATH ?? 'noir-profiler';
36
+ const bb = process.env.BB ?? 'bb';
37
+
38
+ await run(profiler, [
39
+ 'gates',
40
+ '--artifact-path',
41
+ functionArtifact,
42
+ '--backend-path',
43
+ bb,
44
+ '--backend-gates-command',
45
+ 'gates',
46
+ '--output',
47
+ outputDir,
48
+ '--scheme',
49
+ 'chonk',
50
+ '--include_gates_per_opcode',
51
+ ]);
52
+
53
+ // noir-profiler names the SVG using the internal function name which
54
+ // retains the __aztec_nr_internals__ prefix in the bytecode metadata.
55
+ const srcSvg = join(outputDir, `__aztec_nr_internals__${functionName}_gates.svg`);
56
+ const destSvg = join(outputDir, `${contractName}-${functionName}-flamegraph.svg`);
57
+ await rename(srcSvg, destSvg);
58
+
59
+ log(`Flamegraph written to ${destSvg}`);
60
+ } finally {
61
+ await rm(functionArtifact, { force: true });
62
+ }
63
+ }