@aztec/aztec 3.0.3 → 3.9.9-nightly.20260312

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/dest/bin/index.js +9 -3
  2. package/dest/cli/admin_api_key_store.d.ts +45 -0
  3. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  4. package/dest/cli/admin_api_key_store.js +98 -0
  5. package/dest/cli/aztec_start_action.d.ts +1 -1
  6. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  7. package/dest/cli/aztec_start_action.js +55 -15
  8. package/dest/cli/aztec_start_options.d.ts +1 -1
  9. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  10. package/dest/cli/aztec_start_options.js +33 -23
  11. package/dest/cli/cli.d.ts +1 -1
  12. package/dest/cli/cli.d.ts.map +1 -1
  13. package/dest/cli/cli.js +7 -52
  14. package/dest/cli/cmds/compile.d.ts +4 -0
  15. package/dest/cli/cmds/compile.d.ts.map +1 -0
  16. package/dest/cli/cmds/compile.js +68 -0
  17. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  18. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  19. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  20. package/dest/cli/cmds/profile.d.ts +4 -0
  21. package/dest/cli/cmds/profile.d.ts.map +1 -0
  22. package/dest/cli/cmds/profile.js +8 -0
  23. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  24. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  25. package/dest/cli/cmds/profile_flamegraph.js +51 -0
  26. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  27. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  28. package/dest/cli/cmds/profile_gates.js +57 -0
  29. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  30. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  31. package/dest/cli/cmds/profile_utils.js +50 -0
  32. package/dest/cli/cmds/standby.d.ts +27 -0
  33. package/dest/cli/cmds/standby.d.ts.map +1 -0
  34. package/dest/cli/cmds/standby.js +78 -0
  35. package/dest/cli/cmds/start_archiver.d.ts +1 -1
  36. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_archiver.js +10 -12
  38. package/dest/cli/cmds/start_bot.d.ts +3 -3
  39. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  40. package/dest/cli/cmds/start_bot.js +9 -5
  41. package/dest/cli/cmds/start_node.d.ts +3 -2
  42. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  43. package/dest/cli/cmds/start_node.js +77 -27
  44. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  45. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  46. package/dest/cli/cmds/start_p2p_bootstrap.js +1 -2
  47. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  48. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  49. package/dest/cli/cmds/start_prover_agent.js +3 -3
  50. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  51. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  52. package/dest/cli/cmds/start_prover_broker.js +8 -8
  53. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  54. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  55. package/dest/cli/cmds/utils/artifacts.js +24 -0
  56. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  57. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  58. package/dest/cli/cmds/utils/spawn.js +16 -0
  59. package/dest/cli/util.d.ts +7 -18
  60. package/dest/cli/util.d.ts.map +1 -1
  61. package/dest/cli/util.js +48 -84
  62. package/dest/examples/token.js +9 -9
  63. package/dest/local-network/banana_fpc.d.ts +1 -1
  64. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  65. package/dest/local-network/banana_fpc.js +3 -3
  66. package/dest/local-network/local-network.d.ts +6 -5
  67. package/dest/local-network/local-network.d.ts.map +1 -1
  68. package/dest/local-network/local-network.js +74 -30
  69. package/dest/testing/anvil_test_watcher.d.ts +9 -1
  70. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  71. package/dest/testing/anvil_test_watcher.js +52 -15
  72. package/dest/testing/cheat_codes.d.ts +3 -1
  73. package/dest/testing/cheat_codes.d.ts.map +1 -1
  74. package/dest/testing/epoch_test_settler.d.ts +19 -0
  75. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  76. package/dest/testing/epoch_test_settler.js +62 -0
  77. package/dest/testing/index.d.ts +3 -1
  78. package/dest/testing/index.d.ts.map +1 -1
  79. package/dest/testing/index.js +2 -0
  80. package/dest/testing/token_allowed_setup.d.ts +7 -0
  81. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  82. package/dest/testing/token_allowed_setup.js +20 -0
  83. package/package.json +37 -35
  84. package/scripts/aztec.sh +67 -0
  85. package/scripts/init.sh +35 -0
  86. package/scripts/new.sh +59 -0
  87. package/scripts/setup_project.sh +31 -0
  88. package/src/bin/index.ts +9 -3
  89. package/src/cli/admin_api_key_store.ts +128 -0
  90. package/src/cli/aztec_start_action.ts +58 -10
  91. package/src/cli/aztec_start_options.ts +34 -21
  92. package/src/cli/cli.ts +11 -56
  93. package/src/cli/cmds/compile.ts +80 -0
  94. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  95. package/src/cli/cmds/profile.ts +25 -0
  96. package/src/cli/cmds/profile_flamegraph.ts +63 -0
  97. package/src/cli/cmds/profile_gates.ts +67 -0
  98. package/src/cli/cmds/profile_utils.ts +58 -0
  99. package/src/cli/cmds/standby.ts +111 -0
  100. package/src/cli/cmds/start_archiver.ts +6 -17
  101. package/src/cli/cmds/start_bot.ts +8 -5
  102. package/src/cli/cmds/start_node.ts +76 -33
  103. package/src/cli/cmds/start_p2p_bootstrap.ts +2 -2
  104. package/src/cli/cmds/start_prover_agent.ts +3 -11
  105. package/src/cli/cmds/start_prover_broker.ts +12 -15
  106. package/src/cli/cmds/utils/artifacts.ts +44 -0
  107. package/src/cli/cmds/utils/spawn.ts +16 -0
  108. package/src/cli/util.ts +56 -94
  109. package/src/examples/token.ts +10 -10
  110. package/src/local-network/banana_fpc.ts +11 -7
  111. package/src/local-network/local-network.ts +90 -39
  112. package/src/testing/anvil_test_watcher.ts +59 -15
  113. package/src/testing/epoch_test_settler.ts +71 -0
  114. package/src/testing/index.ts +2 -0
  115. package/src/testing/token_allowed_setup.ts +19 -0
  116. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  117. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  118. package/dest/cli/cmds/start_blob_sink.js +0 -33
  119. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  120. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  121. package/dest/cli/cmds/start_prover_node.js +0 -108
  122. package/dest/cli/release_version.d.ts +0 -2
  123. package/dest/cli/release_version.d.ts.map +0 -1
  124. package/dest/cli/release_version.js +0 -14
  125. package/src/cli/cmds/start_blob_sink.ts +0 -57
  126. package/src/cli/cmds/start_prover_node.ts +0 -124
  127. package/src/cli/release_version.ts +0 -21
@@ -1,5 +1,5 @@
1
1
  import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
2
- import { blobSinkConfigMappings } from '@aztec/blob-sink/server/config';
2
+ import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
3
3
  import { botConfigMappings } from '@aztec/bot/config';
4
4
  import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
5
5
  import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
@@ -19,7 +19,7 @@ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/pr
19
19
  import { proverNodeConfigMappings } from '@aztec/prover-node/config';
20
20
  import { allPxeConfigMappings } from '@aztec/pxe/config';
21
21
  import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
22
- import { chainConfigMappings } from '@aztec/stdlib/config';
22
+ import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
23
23
  import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
24
24
  import { worldStateConfigMappings } from '@aztec/world-state/config';
25
25
 
@@ -105,8 +105,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
105
105
  env: 'NETWORK',
106
106
  },
107
107
 
108
- configToFlag('--auto-update', sharedNodeConfigMappings.autoUpdate),
109
- configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
108
+ configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
110
109
 
111
110
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
112
111
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
@@ -142,20 +141,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
142
141
  env: 'AZTEC_ADMIN_PORT',
143
142
  parseVal: val => parseInt(val, 10),
144
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
+ },
145
168
  {
146
169
  flag: '--api-prefix <value>',
147
170
  description: 'Prefix for API routes on any service that is started',
148
171
  defaultValue: '',
149
172
  env: 'API_PREFIX',
150
173
  },
174
+ configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
175
+ configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
151
176
  ],
152
177
  ETHEREUM: [
153
178
  configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
154
179
  // Do not set default for CLI: keep undefined unless provided via flag or env
155
180
  configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
156
- configToFlag('--l1-consensus-host-urls', blobSinkConfigMappings.l1ConsensusHostUrls),
157
- configToFlag('--l1-consensus-host-api-keys', blobSinkConfigMappings.l1ConsensusHostApiKeys),
158
- 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),
159
184
  ],
160
185
  'L1 CONTRACTS': [
161
186
  configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
@@ -168,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
168
193
  'WORLD STATE': [
169
194
  configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
170
195
  configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
171
- configToFlag('--world-state-block-history', worldStateConfigMappings.worldStateBlockHistory),
196
+ configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
172
197
  ],
173
198
  // We can't easily auto-generate node options as they're parts of modules defined below
174
199
  'AZTEC NODE': [
@@ -202,21 +227,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
202
227
  'sequencer',
203
228
  omitConfigMappings(sequencerClientConfigMappings, [
204
229
  'fakeProcessingDelayPerTxMs',
230
+ 'fakeThrowAfterProcessingTxCount',
205
231
  'skipCollectingAttestations',
206
232
  'skipInvalidateBlockAsProposer',
207
233
  'blobSinkMapSizeKb',
208
234
  ]),
209
235
  ),
210
236
  ],
211
- 'BLOB SINK': [
212
- {
213
- flag: '--blob-sink',
214
- description: 'Starts Aztec Blob Sink with options',
215
- defaultValue: undefined,
216
- env: undefined,
217
- },
218
- ...getOptions('blobSink', blobSinkConfigMappings),
219
- ],
220
237
  'PROVER NODE': [
221
238
  {
222
239
  flag: '--prover-node',
@@ -228,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
228
245
  'proverNode',
229
246
  omitConfigMappings(proverNodeConfigMappings, [
230
247
  // filter out options passed separately
231
- ...getKeys(archiverConfigMappings),
232
248
  ...getKeys(proverBrokerConfigMappings),
233
249
  ...getKeys(proverAgentConfigMappings),
234
- ...getKeys(p2pConfigMappings),
235
- ...getKeys(worldStateConfigMappings),
236
- ...getKeys(sharedNodeConfigMappings),
237
250
  ]),
238
251
  ),
239
252
  ],
package/src/cli/cli.ts CHANGED
@@ -31,63 +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
- init [folder] [options]: creates a new Noir project
41
- Options:
42
- --name <name> Name of the package
43
- --contract Use a contract template (default)
44
- --lib Use a library template
45
- --bin Use a binary template
46
- Examples:
47
- $ aztec init # creates a contract project in current directory
48
- $ aztec init --lib # creates a library project
49
-
50
- new <path> [options]: creates a new Noir project in a new directory
51
- Options:
52
- --name <name> Name of the package
53
- --contract Use a contract template (default)
54
- --lib Use a library template
55
- --bin Use a binary template
56
- Examples:
57
- $ aztec new my-project # creates a contract project in ./my-project
58
- $ aztec new my-lib --lib # creates a library project in ./my-lib
59
-
60
- compile [options]: compiles Aztec Noir contracts
61
- Compiles contracts with nargo compile and then postprocesses them to generate Aztec-specific artifacts including:
62
- - Transpiled contract artifacts
63
- - Verification keys
64
- The compiled contracts will be placed in the target/ directory by default.
65
- Supports standard nargo compile options.
66
-
67
- fmt [options]: formats Noir code using nargo fmt
68
- Example:
69
- $ aztec fmt # formats all Noir files in the project
70
-
71
- check [options]: type-checks Noir code without compiling using nargo check
72
- Example:
73
- $ aztec check # checks all Noir files in the project
74
-
75
- test [options]: starts a dockerized TXE node via
76
- $ aztec start --txe
77
- then runs
78
- $ aztec test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
79
-
80
- lsp: starts the Nargo Language Server Protocol server
81
- Runs nargo lsp in a Docker container for IDE integration with Noir.
82
- This command is typically used by IDE extensions and not called directly by users.
83
- Example:
84
- $ aztec lsp # starts the LSP server
85
-
86
- preload-crs: Downloads and caches the Common Reference String (CRS) data required for zero-knowledge proofs.
87
- Example:
88
- $ aztec preload-crs # preloads CRS data
34
+ if (process.env.AZTEC_SHELL_WRAPPER) {
35
+ program.addHelpText(
36
+ 'after',
37
+ `
38
+ Additional commands:
39
+
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.
89
43
  `,
90
- );
44
+ );
45
+ }
91
46
 
92
47
  program
93
48
  .command('preload-crs')
@@ -0,0 +1,80 @@
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
+
7
+ import { readArtifactFiles } from './utils/artifacts.js';
8
+ import { run } from './utils/spawn.js';
9
+
10
+ /** Returns paths to contract artifacts in the target directory. */
11
+ async function collectContractArtifacts(): Promise<string[]> {
12
+ let files;
13
+ try {
14
+ files = await readArtifactFiles('target');
15
+ } catch (err: any) {
16
+ if (err?.message?.includes('does not exist')) {
17
+ return [];
18
+ }
19
+ throw err;
20
+ }
21
+ return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
22
+ }
23
+
24
+ /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
25
+ async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
26
+ for (const path of artifactPaths) {
27
+ const artifact = JSON.parse(await readFile(path, 'utf-8'));
28
+ for (const fn of artifact.functions) {
29
+ if (typeof fn.name === 'string') {
30
+ fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
31
+ }
32
+ }
33
+ await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
34
+ }
35
+ }
36
+
37
+ /** Compiles Aztec Noir contracts and postprocesses artifacts. */
38
+ async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
39
+ const nargo = process.env.NARGO ?? 'nargo';
40
+ const bb = process.env.BB ?? 'bb';
41
+
42
+ await run(nargo, ['compile', ...nargoArgs]);
43
+
44
+ const artifacts = await collectContractArtifacts();
45
+
46
+ if (artifacts.length > 0) {
47
+ log('Postprocessing contracts...');
48
+ const bbArgs = artifacts.flatMap(a => ['-i', a]);
49
+ await run(bb, ['aztec_process', ...bbArgs]);
50
+
51
+ // TODO: This should be part of bb aztec_process!
52
+ await stripInternalPrefixes(artifacts);
53
+ }
54
+
55
+ log('Compilation complete!');
56
+ }
57
+
58
+ export function injectCompileCommand(program: Command, log: LogFn): Command {
59
+ program
60
+ .command('compile')
61
+ .argument('[nargo-args...]')
62
+ .passThroughOptions()
63
+ .allowUnknownOption()
64
+ .description(
65
+ 'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
66
+ )
67
+ .addHelpText('after', () => {
68
+ // Show nargo's own compile options so users see all available flags in one place.
69
+ const nargo = process.env.NARGO ?? 'nargo';
70
+ try {
71
+ const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
72
+ return `\nUnderlying nargo compile options:\n\n${output}`;
73
+ } catch {
74
+ return '\n(Run "nargo compile --help" to see available nargo options)';
75
+ }
76
+ })
77
+ .action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
78
+
79
+ return program;
80
+ }
@@ -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
+ }
@@ -0,0 +1,67 @@
1
+ import { asyncPool } from '@aztec/foundation/async-pool';
2
+ import type { LogFn } from '@aztec/foundation/log';
3
+
4
+ import { execFile as execFileCb } from 'child_process';
5
+ import { rm } from 'fs/promises';
6
+ import { promisify } from 'util';
7
+
8
+ import { MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
9
+
10
+ const execFile = promisify(execFileCb);
11
+
12
+ interface GateCountResult {
13
+ name: string;
14
+ gateCount: number;
15
+ }
16
+
17
+ /** Parses circuit_size from bb gates JSON output: { "functions": [{ "circuit_size": N }] } */
18
+ function parseGateCount(stdout: string): number {
19
+ const parsed = JSON.parse(stdout);
20
+ const size = parsed?.functions?.[0]?.circuit_size;
21
+ if (typeof size !== 'number') {
22
+ throw new Error('Failed to parse circuit_size from bb gates output');
23
+ }
24
+ return size;
25
+ }
26
+
27
+ /** Runs bb gates on a single artifact file and returns the gate count. */
28
+ async function getGateCount(bb: string, artifactPath: string): Promise<number> {
29
+ const { stdout } = await execFile(bb, ['gates', '--scheme', 'chonk', '-b', artifactPath]);
30
+ return parseGateCount(stdout);
31
+ }
32
+
33
+ /** Profiles all compiled artifacts in a target directory and prints gate counts. */
34
+ export async function profileGates(targetDir: string, log: LogFn): Promise<void> {
35
+ const bb = process.env.BB ?? 'bb';
36
+ const { artifacts, tmpDir } = await discoverArtifacts(targetDir);
37
+
38
+ if (artifacts.length === 0) {
39
+ log('No artifacts found in target directory.');
40
+ return;
41
+ }
42
+
43
+ try {
44
+ const results: GateCountResult[] = await asyncPool(MAX_CONCURRENT, artifacts, async artifact => ({
45
+ name: artifact.name,
46
+ gateCount: await getGateCount(bb, artifact.filePath),
47
+ }));
48
+ results.sort((a, b) => a.name.localeCompare(b.name));
49
+
50
+ if (results.length === 0) {
51
+ log('No constrained circuits found.');
52
+ return;
53
+ }
54
+
55
+ const maxNameLen = Math.max(...results.map(r => r.name.length));
56
+ log('');
57
+ log('Gate counts:');
58
+ log('-'.repeat(maxNameLen + 16));
59
+ for (const { name, gateCount } of results) {
60
+ log(`${name.padEnd(maxNameLen)} ${gateCount.toLocaleString().padStart(12)}`);
61
+ }
62
+ log('-'.repeat(maxNameLen + 16));
63
+ log(`Total: ${results.length} circuit(s)`);
64
+ } finally {
65
+ await rm(tmpDir, { recursive: true, force: true });
66
+ }
67
+ }
@@ -0,0 +1,58 @@
1
+ import { mkdtemp, writeFile } from 'fs/promises';
2
+ import { tmpdir } from 'os';
3
+ import { join } from 'path';
4
+
5
+ import type { CompiledArtifact, ContractFunction } from './utils/artifacts.js';
6
+ import { readArtifactFiles } from './utils/artifacts.js';
7
+
8
+ export const MAX_CONCURRENT = 4;
9
+
10
+ export interface DiscoveredArtifact {
11
+ name: string;
12
+ filePath: string;
13
+ type: 'contract-function' | 'program';
14
+ }
15
+
16
+ /**
17
+ * Reads a target directory and returns a list of discovered artifacts with temp files
18
+ * created for contract functions. Caller must clean up tmpDir when done.
19
+ */
20
+ export async function discoverArtifacts(
21
+ targetDir: string,
22
+ ): Promise<{ artifacts: DiscoveredArtifact[]; tmpDir: string }> {
23
+ const files = await readArtifactFiles(targetDir);
24
+ const tmpDir = await mkdtemp(join(tmpdir(), 'aztec-profile-'));
25
+ const artifacts: DiscoveredArtifact[] = [];
26
+
27
+ for (const file of files) {
28
+ if (Array.isArray(file.content.functions)) {
29
+ for (const func of file.content.functions) {
30
+ if (!func.bytecode || func.is_unconstrained) {
31
+ continue;
32
+ }
33
+ const name = `${file.name}::${func.name}`;
34
+ const tmpPath = join(tmpDir, `${file.name}-${func.name}.json`);
35
+ await writeFile(tmpPath, makeFunctionArtifact(file.content, func));
36
+ artifacts.push({ name, filePath: tmpPath, type: 'contract-function' });
37
+ }
38
+ } else if (file.content.bytecode) {
39
+ artifacts.push({ name: file.name, filePath: file.filePath, type: 'program' });
40
+ }
41
+ }
42
+
43
+ return { artifacts, tmpDir };
44
+ }
45
+
46
+ /** Extracts a contract function as a standalone program artifact JSON string. */
47
+ export function makeFunctionArtifact(artifact: CompiledArtifact, func: ContractFunction) {
48
+ /* eslint-disable camelcase */
49
+ return JSON.stringify({
50
+ noir_version: artifact.noir_version,
51
+ hash: 0,
52
+ abi: func.abi,
53
+ bytecode: func.bytecode,
54
+ debug_symbols: func.debug_symbols,
55
+ file_map: artifact.file_map,
56
+ });
57
+ /* eslint-enable camelcase */
58
+ }
@@ -0,0 +1,111 @@
1
+ import { getInitialTestAccountsData } from '@aztec/accounts/testing';
2
+ import type { Fr } from '@aztec/aztec.js/fields';
3
+ import { getSponsoredFPCAddress } from '@aztec/cli/cli-utils';
4
+ import { getPublicClient } from '@aztec/ethereum/client';
5
+ import type { GenesisStateConfig } from '@aztec/ethereum/config';
6
+ import { RegistryContract, RollupContract } from '@aztec/ethereum/contracts';
7
+ import type { EthAddress } from '@aztec/foundation/eth-address';
8
+ import { startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
9
+ import type { LogFn } from '@aztec/foundation/log';
10
+ import { retryUntil } from '@aztec/foundation/retry';
11
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
12
+ import { getGenesisValues } from '@aztec/world-state/testing';
13
+
14
+ import Koa from 'koa';
15
+
16
+ const ROLLUP_POLL_INTERVAL_S = 60;
17
+
18
+ /**
19
+ * Computes the expected genesis archive root from the genesis state config.
20
+ * Reads test accounts and sponsored FPC addresses as specified, then computes
21
+ * the genesis values including the archive root and prefilled public data.
22
+ */
23
+ export async function computeExpectedGenesisRoot(config: GenesisStateConfig, userLog: LogFn) {
24
+ const testAccounts = config.testAccounts ? (await getInitialTestAccountsData()).map(a => a.address) : [];
25
+ const sponsoredFPCAccounts = config.sponsoredFPC ? [await getSponsoredFPCAddress()] : [];
26
+ const prefundAddresses = (config.prefundAddresses ?? []).map(a => AztecAddress.fromString(a));
27
+ const initialFundedAccounts = testAccounts.concat(sponsoredFPCAccounts).concat(prefundAddresses);
28
+
29
+ userLog(`Initial funded accounts: ${initialFundedAccounts.map(a => a.toString()).join(', ')}`);
30
+
31
+ const { genesisArchiveRoot, prefilledPublicData } = await getGenesisValues(initialFundedAccounts);
32
+
33
+ userLog(`Genesis archive root: ${genesisArchiveRoot.toString()}`);
34
+
35
+ return { genesisArchiveRoot, prefilledPublicData };
36
+ }
37
+
38
+ /**
39
+ * Waits until the canonical rollup's genesis archive root matches the expected local genesis root.
40
+ * If the rollup is not yet compatible (e.g. during L1 contract upgrades), enters standby mode:
41
+ * starts a lightweight HTTP server for K8s liveness probes and polls every 60s until a compatible rollup appears.
42
+ */
43
+ export async function waitForCompatibleRollup(
44
+ config: {
45
+ l1RpcUrls: string[];
46
+ l1ChainId: number;
47
+ l1Contracts: { registryAddress: EthAddress };
48
+ rollupVersion?: number;
49
+ },
50
+ expectedGenesisRoot: Fr,
51
+ port: number | undefined,
52
+ userLog: LogFn,
53
+ ): Promise<void> {
54
+ const publicClient = getPublicClient(config);
55
+ const rollupVersion: number | 'canonical' = config.rollupVersion ?? 'canonical';
56
+
57
+ const registry = new RegistryContract(publicClient, config.l1Contracts.registryAddress);
58
+ const rollupAddress = await registry.getRollupAddress(rollupVersion);
59
+ const rollup = new RollupContract(publicClient, rollupAddress.toString());
60
+
61
+ let l1GenesisRoot: Fr;
62
+ try {
63
+ l1GenesisRoot = await rollup.getGenesisArchiveTreeRoot();
64
+ } catch (err: any) {
65
+ throw new Error(
66
+ `Could not retrieve genesis archive root from canonical rollup at ${rollupAddress}: ${err.message}`,
67
+ );
68
+ }
69
+
70
+ if (l1GenesisRoot.equals(expectedGenesisRoot)) {
71
+ return;
72
+ }
73
+
74
+ userLog(
75
+ `Genesis root mismatch: expected ${expectedGenesisRoot}, got ${l1GenesisRoot} from rollup at ${rollupAddress}. ` +
76
+ `Entering standby mode. Will poll every ${ROLLUP_POLL_INTERVAL_S}s for a compatible rollup...`,
77
+ );
78
+
79
+ const standbyServer = await startHttpRpcServer({ getApp: () => new Koa(), isHealthy: () => true }, { port });
80
+ userLog(`Standby status server listening on port ${standbyServer.port}`);
81
+
82
+ try {
83
+ await retryUntil(
84
+ async () => {
85
+ const currentRollupAddress = await registry.getRollupAddress(rollupVersion);
86
+ const currentRollup = new RollupContract(publicClient, currentRollupAddress.toString());
87
+
88
+ let currentGenesisRoot: Fr;
89
+ try {
90
+ currentGenesisRoot = await currentRollup.getGenesisArchiveTreeRoot();
91
+ } catch {
92
+ userLog(`Failed to fetch genesis root from rollup at ${currentRollupAddress}. Retrying...`);
93
+ return undefined;
94
+ }
95
+
96
+ if (currentGenesisRoot.equals(expectedGenesisRoot)) {
97
+ userLog(`Compatible rollup found at ${currentRollupAddress}. Exiting standby mode.`);
98
+ return true;
99
+ }
100
+
101
+ userLog(`Still waiting. Rollup at ${currentRollupAddress} has genesis root ${currentGenesisRoot}.`);
102
+ return undefined;
103
+ },
104
+ 'compatible rollup',
105
+ 0,
106
+ ROLLUP_POLL_INTERVAL_S,
107
+ );
108
+ } finally {
109
+ await new Promise<void>((resolve, reject) => standbyServer.close(err => (err ? reject(err) : resolve())));
110
+ }
111
+ }