@aztec/aztec 5.0.0-private.20260319 → 5.0.0-rc.2

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 (121) hide show
  1. package/dest/bin/index.js +3 -1
  2. package/dest/cli/aztec_start_action.d.ts +1 -1
  3. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  4. package/dest/cli/aztec_start_action.js +16 -24
  5. package/dest/cli/aztec_start_options.d.ts +2 -2
  6. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  7. package/dest/cli/aztec_start_options.js +15 -15
  8. package/dest/cli/cmds/compile.d.ts +1 -1
  9. package/dest/cli/cmds/compile.d.ts.map +1 -1
  10. package/dest/cli/cmds/compile.js +32 -24
  11. package/dest/cli/cmds/profile.d.ts +1 -1
  12. package/dest/cli/cmds/profile.d.ts.map +1 -1
  13. package/dest/cli/cmds/profile.js +1 -1
  14. package/dest/cli/cmds/profile_gates.d.ts +2 -2
  15. package/dest/cli/cmds/profile_gates.d.ts.map +1 -1
  16. package/dest/cli/cmds/profile_gates.js +21 -3
  17. package/dest/cli/cmds/prover.d.ts +4 -0
  18. package/dest/cli/cmds/prover.d.ts.map +1 -0
  19. package/dest/cli/cmds/prover.js +24 -0
  20. package/dest/cli/cmds/standby.d.ts +30 -6
  21. package/dest/cli/cmds/standby.d.ts.map +1 -1
  22. package/dest/cli/cmds/standby.js +48 -5
  23. package/dest/cli/cmds/start_bot.d.ts +1 -1
  24. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  25. package/dest/cli/cmds/start_bot.js +8 -4
  26. package/dest/cli/cmds/start_node.d.ts +1 -1
  27. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  28. package/dest/cli/cmds/start_node.js +22 -47
  29. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  30. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  31. package/dest/cli/cmds/start_prover_agent.js +5 -17
  32. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  33. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  34. package/dest/cli/cmds/start_prover_broker.js +11 -8
  35. package/dest/cli/cmds/start_txe.d.ts +2 -2
  36. package/dest/cli/cmds/start_txe.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_txe.js +6 -5
  38. package/dest/cli/cmds/utils/artifacts.d.ts +6 -1
  39. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -1
  40. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts +21 -0
  41. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
  42. package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
  43. package/dest/cli/cmds/utils/needs_recompile.d.ts +1 -1
  44. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -1
  45. package/dest/cli/cmds/utils/needs_recompile.js +9 -53
  46. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
  47. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
  48. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +61 -0
  49. package/dest/cli/util.d.ts +10 -5
  50. package/dest/cli/util.d.ts.map +1 -1
  51. package/dest/cli/util.js +25 -52
  52. package/dest/examples/token.js +3 -3
  53. package/dest/local-network/auth_registry.d.ts +5 -0
  54. package/dest/local-network/auth_registry.d.ts.map +1 -0
  55. package/dest/local-network/auth_registry.js +17 -0
  56. package/dest/local-network/banana_fpc.d.ts +3 -2
  57. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  58. package/dest/local-network/banana_fpc.js +11 -7
  59. package/dest/local-network/local-network.d.ts +8 -32
  60. package/dest/local-network/local-network.d.ts.map +1 -1
  61. package/dest/local-network/local-network.js +48 -73
  62. package/dest/testing/cheat_codes.d.ts +17 -23
  63. package/dest/testing/cheat_codes.d.ts.map +1 -1
  64. package/dest/testing/cheat_codes.js +17 -43
  65. package/dest/testing/epoch_test_settler.d.ts +2 -2
  66. package/dest/testing/epoch_test_settler.d.ts.map +1 -1
  67. package/dest/testing/epoch_test_settler.js +6 -25
  68. package/dest/testing/index.d.ts +1 -2
  69. package/dest/testing/index.d.ts.map +1 -1
  70. package/dest/testing/index.js +0 -1
  71. package/dest/testing/token_allowed_setup.d.ts +9 -4
  72. package/dest/testing/token_allowed_setup.d.ts.map +1 -1
  73. package/dest/testing/token_allowed_setup.js +12 -8
  74. package/package.json +34 -33
  75. package/scripts/add_crate.sh +11 -60
  76. package/scripts/aztec.sh +6 -2
  77. package/scripts/init.sh +5 -5
  78. package/scripts/new.sh +2 -2
  79. package/scripts/setup_workspace.sh +3 -2
  80. package/scripts/templates/blank/contract/Nargo.toml +6 -0
  81. package/scripts/templates/blank/contract/src/main.nr +10 -0
  82. package/scripts/templates/blank/test/Nargo.toml +7 -0
  83. package/scripts/templates/blank/test/src/lib.nr +11 -0
  84. package/scripts/templates/counter/contract/Nargo.toml +7 -0
  85. package/scripts/templates/counter/contract/src/main.nr +48 -0
  86. package/scripts/templates/counter/test/Nargo.toml +7 -0
  87. package/scripts/templates/counter/test/src/lib.nr +32 -0
  88. package/src/bin/index.ts +3 -1
  89. package/src/cli/aztec_start_action.ts +14 -17
  90. package/src/cli/aztec_start_options.ts +22 -23
  91. package/src/cli/cmds/compile.ts +37 -23
  92. package/src/cli/cmds/profile.ts +2 -1
  93. package/src/cli/cmds/profile_gates.ts +20 -4
  94. package/src/cli/cmds/prover.ts +42 -0
  95. package/src/cli/cmds/standby.ts +59 -7
  96. package/src/cli/cmds/start_bot.ts +9 -6
  97. package/src/cli/cmds/start_node.ts +29 -39
  98. package/src/cli/cmds/start_prover_agent.ts +5 -8
  99. package/src/cli/cmds/start_prover_broker.ts +10 -11
  100. package/src/cli/cmds/start_txe.ts +7 -5
  101. package/src/cli/cmds/utils/artifacts.ts +5 -0
  102. package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
  103. package/src/cli/cmds/utils/needs_recompile.ts +8 -61
  104. package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +76 -0
  105. package/src/cli/util.ts +26 -67
  106. package/src/examples/token.ts +3 -3
  107. package/src/local-network/auth_registry.ts +19 -0
  108. package/src/local-network/banana_fpc.ts +12 -8
  109. package/src/local-network/local-network.ts +52 -83
  110. package/src/testing/cheat_codes.ts +18 -49
  111. package/src/testing/epoch_test_settler.ts +8 -31
  112. package/src/testing/index.ts +0 -1
  113. package/src/testing/token_allowed_setup.ts +15 -8
  114. package/dest/cli/cmds/start_archiver.d.ts +0 -9
  115. package/dest/cli/cmds/start_archiver.d.ts.map +0 -1
  116. package/dest/cli/cmds/start_archiver.js +0 -48
  117. package/dest/testing/anvil_test_watcher.d.ts +0 -42
  118. package/dest/testing/anvil_test_watcher.d.ts.map +0 -1
  119. package/dest/testing/anvil_test_watcher.js +0 -181
  120. package/src/cli/cmds/start_archiver.ts +0 -50
  121. package/src/testing/anvil_test_watcher.ts +0 -210
@@ -0,0 +1,48 @@
1
+ use aztec::macros::aztec;
2
+
3
+ #[aztec]
4
+ pub contract Counter {
5
+ use aztec::{
6
+ macros::{functions::{external, initializer}, storage::storage},
7
+ messages::delivery::MessageDelivery,
8
+ protocol::address::AztecAddress,
9
+ state_vars::Owned,
10
+ };
11
+ use balance_set::BalanceSet;
12
+
13
+ #[storage]
14
+ struct Storage<Context> {
15
+ // Each owner has their own counter, stored as private encrypted notes.
16
+ // Owned: dictates who will receive the encrypted notes.
17
+ // BalanceSet: manages the underlying notes, providing add/sub/balance_of.
18
+ counters: Owned<BalanceSet<Context>, Context>,
19
+ }
20
+
21
+ // Sets the owner's counter to an initial value.
22
+ //
23
+ // #[external("private")]: executes on the user's device, inputs are hidden from everyone.
24
+ #[initializer]
25
+ #[external("private")]
26
+ fn constructor(initial_value: u128, owner: AztecAddress) {
27
+ // Delivers the note to the recipient onchain.
28
+ // Without delivery, the recipient can't find or decrypt the note.
29
+ self.storage.counters.at(owner).add(initial_value).deliver(
30
+ MessageDelivery::onchain_unconstrained(),
31
+ );
32
+ }
33
+
34
+ // Adds 1 to the owner's counter.
35
+ #[external("private")]
36
+ fn increment(owner: AztecAddress) {
37
+ self.storage.counters.at(owner).add(1).deliver(MessageDelivery::onchain_unconstrained());
38
+ }
39
+
40
+ // Returns the current value of the owner's counter.
41
+ //
42
+ // #[external("utility")]: runs off-chain, no transaction created, no cost.
43
+ // Only the owner can decrypt and read their own counter.
44
+ #[external("utility")]
45
+ unconstrained fn get_counter(owner: AztecAddress) -> u128 {
46
+ self.storage.counters.at(owner).balance_of()
47
+ }
48
+ }
@@ -0,0 +1,7 @@
1
+ [package]
2
+ name = "__CRATE_NAME___test"
3
+ type = "lib"
4
+
5
+ [dependencies]
6
+ aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }
7
+ __CRATE_NAME___contract = { path = "../__CRATE_NAME___contract" }
@@ -0,0 +1,32 @@
1
+ use aztec::{protocol::address::AztecAddress, test::helpers::test_environment::TestEnvironment};
2
+ use __CRATE_NAME___contract::Counter;
3
+
4
+ unconstrained fn setup(initial_value: u128) -> (TestEnvironment, AztecAddress, AztecAddress) {
5
+ let mut env = TestEnvironment::new();
6
+ let owner = env.create_light_account();
7
+
8
+ let contract_address = env.deploy("@__CRATE_NAME___contract/Counter")
9
+ .with_private_initializer(owner, Counter::interface().constructor(initial_value, owner));
10
+
11
+ (env, contract_address, owner)
12
+ }
13
+
14
+ #[test]
15
+ unconstrained fn test_constructor() {
16
+ let initial_value = 5;
17
+ let (env, contract_address, owner) = setup(initial_value);
18
+
19
+ let counter = env.execute_utility(Counter::at(contract_address).get_counter(owner));
20
+ assert_eq(counter, initial_value);
21
+ }
22
+
23
+ #[test]
24
+ unconstrained fn test_increment() {
25
+ let initial_value = 5;
26
+ let (mut env, contract_address, owner) = setup(initial_value);
27
+
28
+ env.call_private(owner, Counter::at(contract_address).increment(owner));
29
+
30
+ let counter = env.execute_utility(Counter::at(contract_address).get_counter(owner));
31
+ assert_eq(counter, initial_value + 1);
32
+ }
package/src/bin/index.ts CHANGED
@@ -18,6 +18,7 @@ import { Command } from 'commander';
18
18
  import { injectCompileCommand } from '../cli/cmds/compile.js';
19
19
  import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
20
20
  import { injectProfileCommand } from '../cli/cmds/profile.js';
21
+ import { injectProverCommand } from '../cli/cmds/prover.js';
21
22
  import { injectAztecCommands } from '../cli/index.js';
22
23
 
23
24
  const NETWORK_FLAG = 'network';
@@ -47,7 +48,7 @@ async function main() {
47
48
  await enrichEnvironmentWithNetworkConfig(networkName);
48
49
  enrichEnvironmentWithChainName(networkName);
49
50
 
50
- const cliVersion = getPackageVersion() ?? 'unknown';
51
+ const cliVersion = getPackageVersion();
51
52
  let program = new Command('aztec');
52
53
  program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
53
54
  program = injectAztecCommands(program, userLog, debugLogger);
@@ -61,6 +62,7 @@ async function main() {
61
62
  program = injectCompileCommand(program, userLog);
62
63
  program = injectProfileCommand(program, userLog);
63
64
  program = injectMigrateCommand(program, userLog);
65
+ program = injectProverCommand(program, userLog);
64
66
 
65
67
  await program.parseAsync(process.argv);
66
68
  }
@@ -1,3 +1,4 @@
1
+ import { registerAztecNodeRpcHandlers } from '@aztec/aztec-node';
1
2
  import { getActiveNetworkName } from '@aztec/foundation/config';
2
3
  import {
3
4
  type NamespacedApiHandlers,
@@ -7,10 +8,9 @@ import {
7
8
  } from '@aztec/foundation/json-rpc/server';
8
9
  import type { LogFn, Logger } from '@aztec/foundation/log';
9
10
  import type { ChainConfig } from '@aztec/stdlib/config';
10
- import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
11
11
  import { getPackageVersion } from '@aztec/stdlib/update-checker';
12
12
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
13
- import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
13
+ import { getOtelJsonRpcDiagnosticsMiddleware, getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
14
14
 
15
15
  import { createLocalNetwork } from '../local-network/index.js';
16
16
  import { github, splash } from '../splash.js';
@@ -27,30 +27,22 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
27
27
  let config: ChainConfig | undefined = undefined;
28
28
 
29
29
  if (options.localNetwork) {
30
- const localNetwork = extractNamespacedOptions(options, 'local-network');
31
- localNetwork.testAccounts = true;
30
+ const localNetwork = extractNamespacedOptions(options, 'localNetwork');
32
31
  userLog(`${splash}\n${github}\n\n`);
33
- userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
32
+ userLog(`Setting up Aztec local network ${packageVersion}, please stand by...`);
34
33
 
35
34
  const { node, stop } = await createLocalNetwork(
36
35
  {
37
36
  l1Mnemonic: localNetwork.l1Mnemonic,
38
37
  l1RpcUrls: options.l1RpcUrls,
39
38
  testAccounts: localNetwork.testAccounts,
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,
46
39
  },
47
40
  userLog,
48
41
  );
49
42
 
50
43
  // Start Node and PXE JSON-RPC server
51
44
  signalHandlers.push(stop);
52
- services.node = [node, AztecNodeApiSchema];
53
- adminServices.node = [node, AztecNodeAdminApiSchema];
45
+ registerAztecNodeRpcHandlers(node, services, adminServices, { debug: true });
54
46
  } else {
55
47
  // Route --prover-node through startNode
56
48
  if (options.proverNode && !options.node) {
@@ -64,9 +56,6 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
64
56
  } else if (options.bot) {
65
57
  const { startBot } = await import('./cmds/start_bot.js');
66
58
  await startBot(options, signalHandlers, services, userLog);
67
- } else if (options.archiver) {
68
- const { startArchiver } = await import('./cmds/start_archiver.js');
69
- ({ config } = await startArchiver(options, signalHandlers, services));
70
59
  } else if (options.p2pBootstrap) {
71
60
  const { startP2PBootstrap } = await import('./cmds/start_p2p_bootstrap.js');
72
61
  ({ config } = await startP2PBootstrap(options, signalHandlers, services, userLog));
@@ -78,7 +67,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
78
67
  await startProverBroker(options, signalHandlers, services, userLog);
79
68
  } else if (options.txe) {
80
69
  const { startTXE } = await import('./cmds/start_txe.js');
81
- await startTXE(options, debugLogger);
70
+ await startTXE(options, signalHandlers, debugLogger);
82
71
  } else if (options.sequencer) {
83
72
  userLog(`Cannot run a standalone sequencer without a node`);
84
73
  process.exit(1);
@@ -94,7 +83,14 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
94
83
 
95
84
  // Start the main JSON-RPC server
96
85
  if (Object.entries(services).length > 0) {
86
+ if (services.aztec) {
87
+ const { BarretenbergSync } = await import('@aztec/bb.js');
88
+ // JSON-RPC schema parsing may decompress compressed Chonk proofs before the node handler runs.
89
+ await BarretenbergSync.initSingleton();
90
+ }
91
+
97
92
  const rpcServer = createNamespacedSafeJsonRpcServer(services, {
93
+ diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
98
94
  http200OnError: false,
99
95
  log: debugLogger,
100
96
  middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
@@ -126,6 +122,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
126
122
  }
127
123
 
128
124
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
125
+ diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
129
126
  http200OnError: false,
130
127
  log: debugLogger,
131
128
  middlewares: adminMiddlewares,
@@ -36,7 +36,7 @@ export interface AztecStartOption {
36
36
  parseVal?: (val: string) => any;
37
37
  }
38
38
 
39
- export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping>) => {
39
+ export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => {
40
40
  const options: AztecStartOption[] = [];
41
41
  for (const [key, { env, defaultValue: def, parseEnv, description, printDefault, fallback }] of Object.entries(
42
42
  configMappings,
@@ -58,7 +58,11 @@ export const getOptions = (namespace: string, configMappings: Record<string, Con
58
58
  return options;
59
59
  };
60
60
 
61
- const configToFlag = (flag: string, configMapping: ConfigMapping, overrideDefaultValue?: any): AztecStartOption => {
61
+ const configToFlag = (
62
+ flag: string,
63
+ configMapping: ConfigMapping<unknown>,
64
+ overrideDefaultValue?: any,
65
+ ): AztecStartOption => {
62
66
  if (!configMapping.isBoolean) {
63
67
  flag += ' <value>';
64
68
  }
@@ -105,7 +109,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
105
109
  env: 'NETWORK',
106
110
  },
107
111
 
108
- configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
112
+ configToFlag('--enable-auto-shutdown', sharedNodeConfigMappings.enableAutoShutdown),
109
113
 
110
114
  configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
111
115
  configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
@@ -125,6 +129,12 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
125
129
  defaultValue: DefaultMnemonic,
126
130
  env: 'MNEMONIC',
127
131
  },
132
+ {
133
+ flag: '--local-network.testAccounts',
134
+ description: 'Deploy test accounts on local network start',
135
+ env: 'TEST_ACCOUNTS',
136
+ ...booleanConfigHelper(true),
137
+ },
128
138
  ],
129
139
  API: [
130
140
  {
@@ -165,6 +175,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
165
175
  env: 'AZTEC_RESET_ADMIN_API_KEY',
166
176
  parseVal: val => val === 'true' || val === '1',
167
177
  },
178
+ {
179
+ flag: '--node-debug',
180
+ description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
181
+ defaultValue: false,
182
+ env: 'AZTEC_NODE_DEBUG',
183
+ parseVal: val => val === undefined || val === 'true' || val === '1',
184
+ },
168
185
  {
169
186
  flag: '--api-prefix <value>',
170
187
  description: 'Prefix for API routes on any service that is started',
@@ -205,12 +222,6 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
205
222
  },
206
223
  ],
207
224
  ARCHIVER: [
208
- {
209
- flag: '--archiver',
210
- description: 'Starts Aztec Archiver with options',
211
- defaultValue: undefined,
212
- env: undefined,
213
- },
214
225
  ...getOptions(
215
226
  'archiver',
216
227
  omitConfigMappings(archiverConfigMappings, Object.keys(l1ContractsConfigMappings) as (keyof ArchiverConfig)[]),
@@ -257,11 +268,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
257
268
  defaultValue: undefined,
258
269
  env: undefined,
259
270
  },
260
- ...getOptions(
261
- 'proverBroker',
262
- // filter out archiver options from prover node options as they're passed separately in --archiver
263
- proverBrokerConfigMappings,
264
- ),
271
+ ...getOptions('proverBroker', proverBrokerConfigMappings),
265
272
  ],
266
273
  'PROVER AGENT': [
267
274
  {
@@ -309,15 +316,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
309
316
  },
310
317
  ...getOptions('bot', botConfigMappings),
311
318
  ],
312
- PXE: [
313
- {
314
- flag: '--pxe',
315
- description: 'Starts Aztec PXE with options',
316
- defaultValue: undefined,
317
- env: undefined,
318
- },
319
- ...getOptions('pxe', allPxeConfigMappings),
320
- ],
319
+ PXE: [...getOptions('pxe', allPxeConfigMappings)],
321
320
  TXE: [
322
321
  {
323
322
  flag: '--txe',
@@ -1,5 +1,6 @@
1
1
  import { findBbBinary } from '@aztec/bb.js';
2
2
  import type { LogFn } from '@aztec/foundation/log';
3
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
3
4
 
4
5
  import { execFileSync } from 'child_process';
5
6
  import type { Command } from 'commander';
@@ -9,9 +10,10 @@ import { join } from 'path';
9
10
  import { readArtifactFiles } from './utils/artifacts.js';
10
11
  import { needsRecompile } from './utils/needs_recompile.js';
11
12
  import { run } from './utils/spawn.js';
13
+ import { warnIfAztecVersionMismatch } from './utils/warn_if_aztec_version_mismatch.js';
12
14
 
13
- /** Returns paths to contract artifacts in the target directory. */
14
- async function collectContractArtifacts(): Promise<string[]> {
15
+ /** Returns contract artifacts in the target directory along with whether each has already been postprocessed. */
16
+ async function collectContractArtifacts(): Promise<ContractArtifactInfo[]> {
15
17
  let files;
16
18
  try {
17
19
  files = await readArtifactFiles('target');
@@ -21,18 +23,18 @@ async function collectContractArtifacts(): Promise<string[]> {
21
23
  }
22
24
  throw err;
23
25
  }
24
- return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
26
+ return files
27
+ .filter(f => Array.isArray(f.content.functions))
28
+ .map(f => ({ filePath: f.filePath, transpiled: f.content.transpiled === true }));
25
29
  }
26
30
 
27
- /** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
28
- async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
31
+ /** Stamps the Aztec stack version into the contract artifacts. */
32
+ async function stampAztecVersion(artifactPaths: string[]): Promise<void> {
33
+ const version = getPackageVersion();
29
34
  for (const path of artifactPaths) {
30
35
  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
+ // eslint-disable-next-line camelcase
37
+ artifact.aztec_version = version;
36
38
  await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
37
39
  }
38
40
  }
@@ -139,31 +141,36 @@ async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void>
139
141
 
140
142
  /** Compiles Aztec Noir contracts and postprocesses artifacts. */
141
143
  async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
142
- if (!(await needsRecompile())) {
143
- log('No source changes detected, skipping compilation.');
144
- return;
145
- }
144
+ await warnIfAztecVersionMismatch(log);
146
145
 
147
146
  const nargo = process.env.NARGO ?? 'nargo';
148
147
  const bb = process.env.BB ?? findBbBinary() ?? 'bb';
149
148
 
150
- await run(nargo, ['compile', ...nargoArgs]);
149
+ const shouldRecompile = await needsRecompile();
150
+ if (shouldRecompile) {
151
+ await run(nargo, ['compile', ...nargoArgs]);
151
152
 
152
- // Ensure contract crates contain no tests (tests belong in the test crate).
153
- await checkNoTestsInContracts(nargo, log);
153
+ // Ensure contract crates contain no tests (tests belong in the test crate).
154
+ await checkNoTestsInContracts(nargo, log);
155
+ }
154
156
 
155
- const artifacts = await collectContractArtifacts();
157
+ // Postprocess any untranspiled artifacts: those just produced by nargo above, and any left behind by a bare
158
+ // `nargo compile` run outside `aztec compile`.
159
+ const unprocessed = (await collectContractArtifacts()).filter(a => !a.transpiled).map(a => a.filePath);
156
160
 
157
- if (artifacts.length > 0) {
161
+ if (unprocessed.length > 0) {
158
162
  log('Postprocessing contracts...');
159
- const bbArgs = artifacts.flatMap(a => ['-i', a]);
163
+ const bbArgs = unprocessed.flatMap(a => ['-i', a]);
160
164
  await run(bb, ['aztec_process', ...bbArgs]);
161
165
 
162
- // TODO: This should be part of bb aztec_process!
163
- await stripInternalPrefixes(artifacts);
166
+ await stampAztecVersion(unprocessed);
164
167
  }
165
168
 
166
- log('Compilation complete!');
169
+ if (shouldRecompile || unprocessed.length > 0) {
170
+ log('Compilation complete!');
171
+ } else {
172
+ log('No source changes detected, skipping compilation.');
173
+ }
167
174
  }
168
175
 
169
176
  export function injectCompileCommand(program: Command, log: LogFn): Command {
@@ -189,3 +196,10 @@ export function injectCompileCommand(program: Command, log: LogFn): Command {
189
196
 
190
197
  return program;
191
198
  }
199
+
200
+ interface ContractArtifactInfo {
201
+ /** Path to the artifact JSON in the target directory. */
202
+ filePath: string;
203
+ /** Whether the artifact has already been transpiled and had its verification keys generated. */
204
+ transpiled: boolean;
205
+ }
@@ -11,8 +11,9 @@ export function injectProfileCommand(program: Command, log: LogFn): Command {
11
11
  profile
12
12
  .command('gates')
13
13
  .argument('[target-dir]', 'Path to the compiled artifacts directory', './target')
14
+ .option('--json', 'Output gate counts as JSON instead of a table', false)
14
15
  .description('Display gate counts for all compiled Aztec artifacts in a target directory.')
15
- .action((targetDir: string) => profileGates(targetDir, log));
16
+ .action((targetDir: string, options: { json: boolean }) => profileGates(targetDir, options.json, log));
16
17
 
17
18
  profile
18
19
  .command('flamegraph')
@@ -6,12 +6,13 @@ import { execFile as execFileCb } from 'child_process';
6
6
  import { rm } from 'fs/promises';
7
7
  import { promisify } from 'util';
8
8
 
9
- import { MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
9
+ import { type DiscoveredArtifact, MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
10
10
 
11
11
  const execFile = promisify(execFileCb);
12
12
 
13
13
  interface GateCountResult {
14
14
  name: string;
15
+ type: DiscoveredArtifact['type'];
15
16
  gateCount: number;
16
17
  }
17
18
 
@@ -32,24 +33,39 @@ async function getGateCount(bb: string, artifactPath: string): Promise<number> {
32
33
  }
33
34
 
34
35
  /** Profiles all compiled artifacts in a target directory and prints gate counts. */
35
- export async function profileGates(targetDir: string, log: LogFn): Promise<void> {
36
+ export async function profileGates(targetDir: string, json: boolean, log: LogFn): Promise<void> {
36
37
  const bb = process.env.BB ?? findBbBinary() ?? 'bb';
37
38
  const { artifacts, tmpDir } = await discoverArtifacts(targetDir);
38
39
 
39
40
  if (artifacts.length === 0) {
40
- log('No artifacts found in target directory.');
41
+ if (json) {
42
+ log('[]');
43
+ } else {
44
+ log('No artifacts found in target directory.');
45
+ }
41
46
  return;
42
47
  }
43
48
 
44
49
  try {
45
50
  const results: GateCountResult[] = await asyncPool(MAX_CONCURRENT, artifacts, async artifact => ({
46
51
  name: artifact.name,
52
+ type: artifact.type,
47
53
  gateCount: await getGateCount(bb, artifact.filePath),
48
54
  }));
49
55
  results.sort((a, b) => a.name.localeCompare(b.name));
50
56
 
51
57
  if (results.length === 0) {
52
- log('No constrained circuits found.');
58
+ if (json) {
59
+ log('[]');
60
+ } else {
61
+ log('No constrained circuits found.');
62
+ }
63
+ return;
64
+ }
65
+
66
+ if (json) {
67
+ const entries = results.map(r => ({ name: r.name, type: r.type, gates: r.gateCount }));
68
+ log(JSON.stringify(entries, null, 2));
53
69
  return;
54
70
  }
55
71
 
@@ -0,0 +1,42 @@
1
+ import { jsonStringify } from '@aztec/foundation/json-rpc';
2
+ import type { LogFn } from '@aztec/foundation/log';
3
+ import { createProverNodeAdminClient } from '@aztec/stdlib/interfaces/server';
4
+
5
+ import { type Command, InvalidArgumentError } from 'commander';
6
+
7
+ function parseEpoch(value: string): number {
8
+ const parsed = Number(value);
9
+ if (!Number.isInteger(parsed) || parsed < 0) {
10
+ throw new InvalidArgumentError('Epoch must be a non-negative integer.');
11
+ }
12
+ return parsed;
13
+ }
14
+
15
+ export function injectProverCommand(program: Command, log: LogFn): Command {
16
+ const proverCommand = program.command('prover').description('Operate a prover node via its admin JSON-RPC endpoint');
17
+
18
+ proverCommand
19
+ .command('start-proof')
20
+ .description('Schedules proving for the given epoch')
21
+ .requiredOption('--epoch <n>', 'Epoch number to prove', parseEpoch)
22
+ .requiredOption('--admin-url <url>', 'URL of the prover node admin JSON-RPC endpoint')
23
+ .option('--api-key <key>', 'Admin API key', process.env.AZTEC_ADMIN_API_KEY)
24
+ .action(async options => {
25
+ const client = createProverNodeAdminClient(options.adminUrl, {}, undefined, options.apiKey);
26
+ const jobId = await client.startProof(options.epoch);
27
+ log(`Started proving job ${jobId} for epoch ${options.epoch}`);
28
+ });
29
+
30
+ proverCommand
31
+ .command('get-jobs')
32
+ .description('Lists the prover node proving jobs')
33
+ .requiredOption('--admin-url <url>', 'URL of the prover node admin JSON-RPC endpoint')
34
+ .option('--api-key <key>', 'Admin API key', process.env.AZTEC_ADMIN_API_KEY)
35
+ .action(async options => {
36
+ const client = createProverNodeAdminClient(options.adminUrl, {}, undefined, options.apiKey);
37
+ const jobs = await client.getJobs();
38
+ log(jsonStringify(jobs, true));
39
+ });
40
+
41
+ return program;
42
+ }
@@ -6,13 +6,16 @@ import type { GenesisStateConfig } from '@aztec/ethereum/config';
6
6
  import { RegistryContract, RollupContract } from '@aztec/ethereum/contracts';
7
7
  import type { EthAddress } from '@aztec/foundation/eth-address';
8
8
  import { startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
9
- import type { LogFn } from '@aztec/foundation/log';
9
+ import { type LogFn, createLogger } from '@aztec/foundation/log';
10
10
  import { retryUntil } from '@aztec/foundation/retry';
11
11
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
12
+ import type { VersionCheck } from '@aztec/stdlib/update-checker';
12
13
  import { getGenesisValues } from '@aztec/world-state/testing';
13
14
 
14
15
  import Koa from 'koa';
15
16
 
17
+ import { isShuttingDown, softShutdown } from '../util.js';
18
+
16
19
  const ROLLUP_POLL_INTERVAL_S = 60;
17
20
 
18
21
  /**
@@ -23,19 +26,24 @@ const ROLLUP_POLL_INTERVAL_S = 60;
23
26
  export async function computeExpectedGenesisRoot(config: GenesisStateConfig, userLog: LogFn) {
24
27
  const testAccounts = config.testAccounts ? (await getInitialTestAccountsData()).map(a => a.address) : [];
25
28
  const sponsoredFPCAccounts = config.sponsoredFPC ? [await getSponsoredFPCAddress()] : [];
26
- const prefundAddresses = (config.prefundAddresses ?? []).map(a => AztecAddress.fromString(a));
29
+ const prefundAddresses = (config.prefundAddresses ?? []).map(a => AztecAddress.fromStringUnsafe(a));
27
30
  const initialFundedAccounts = testAccounts.concat(sponsoredFPCAccounts).concat(prefundAddresses);
28
31
 
29
32
  userLog(`Initial funded accounts: ${initialFundedAccounts.map(a => a.toString()).join(', ')}`);
30
33
 
31
- const { genesisArchiveRoot, prefilledPublicData } = await getGenesisValues(initialFundedAccounts);
34
+ const { genesisArchiveRoot, genesis } = await getGenesisValues(initialFundedAccounts);
32
35
 
33
36
  userLog(`Genesis archive root: ${genesisArchiveRoot.toString()}`);
34
37
 
35
- return { genesisArchiveRoot, prefilledPublicData };
38
+ return { genesisArchiveRoot, genesis };
36
39
  }
37
40
 
38
- async function checkRollupCompatibility(
41
+ /**
42
+ * Compares the rollup's on-chain protocol constants (genesis archive root, VK tree root, protocol
43
+ * contracts hash) against the node's expected local values. Returns a list of human-readable mismatch
44
+ * descriptions, empty if the rollup is compatible.
45
+ */
46
+ export async function checkRollupCompatibility(
39
47
  rollup: RollupContract,
40
48
  expected: { genesisArchiveRoot: Fr; vkTreeRoot: Fr; protocolContractsHash: Fr },
41
49
  ): Promise<string[]> {
@@ -67,7 +75,7 @@ export async function waitForCompatibleRollup(
67
75
  config: {
68
76
  l1RpcUrls: string[];
69
77
  l1ChainId: number;
70
- l1Contracts: { registryAddress: EthAddress };
78
+ registryAddress: EthAddress;
71
79
  rollupVersion?: number;
72
80
  },
73
81
  expected: { genesisArchiveRoot: Fr; vkTreeRoot: Fr; protocolContractsHash: Fr },
@@ -77,7 +85,7 @@ export async function waitForCompatibleRollup(
77
85
  const publicClient = getPublicClient(config);
78
86
  const rollupVersion: number | 'canonical' = config.rollupVersion ?? 'canonical';
79
87
 
80
- const registry = new RegistryContract(publicClient, config.l1Contracts.registryAddress);
88
+ const registry = new RegistryContract(publicClient, config.registryAddress);
81
89
  const rollupAddress = await registry.getRollupAddress(rollupVersion);
82
90
  const rollup = new RollupContract(publicClient, rollupAddress.toString());
83
91
 
@@ -130,3 +138,47 @@ export async function waitForCompatibleRollup(
130
138
  await new Promise<void>((resolve, reject) => standbyServer.close(err => (err ? reject(err) : resolve())));
131
139
  }
132
140
  }
141
+
142
+ /**
143
+ * Polls the canonical rollup's protocol constants every 10 minutes and soft-shuts-down the node once they
144
+ * diverge from the node's expected local values (i.e. an incompatible rollup has become canonical on L1).
145
+ * The HTTP health server is left running so K8s probes keep passing on the wound-down pod. This is the
146
+ * inverse of {@link waitForCompatibleRollup}; it should only be set up for nodes following the canonical
147
+ * rollup. Reuses the {@link checkRollupCompatibility} diff and the generic VersionChecker poll primitive.
148
+ */
149
+ export async function setupAutoShutdown(
150
+ config: { l1RpcUrls: string[]; l1ChainId: number },
151
+ registryAddress: EthAddress,
152
+ rollupVersion: number | 'canonical',
153
+ expected: { genesisArchiveRoot: Fr; vkTreeRoot: Fr; protocolContractsHash: Fr },
154
+ signalHandlers: Array<() => Promise<void>>,
155
+ ): Promise<void> {
156
+ const { VersionChecker } = await import('@aztec/stdlib/update-checker');
157
+
158
+ const logger = createLogger('auto_shutdown');
159
+ const publicClient = getPublicClient(config);
160
+ const registry = new RegistryContract(publicClient, registryAddress);
161
+
162
+ const check: VersionCheck = {
163
+ name: 'rollup',
164
+ currentVersion: 'compatible',
165
+ getLatestVersion: async () => {
166
+ const rollupAddress = await registry.getRollupAddress(rollupVersion);
167
+ const rollup = new RollupContract(publicClient, rollupAddress.toString());
168
+ const mismatches = await checkRollupCompatibility(rollup, expected);
169
+ return mismatches.length === 0 ? 'compatible' : `incompatible: ${mismatches.join('; ')}`;
170
+ },
171
+ };
172
+
173
+ const checker = new VersionChecker([check], 600_000, logger);
174
+ checker.on('newVersion', ({ latestVersion }) => {
175
+ if (isShuttingDown()) {
176
+ return;
177
+ }
178
+ logger.warn('Canonical rollup is no longer compatible; auto-shutting down node', { latestVersion });
179
+ // softShutdown never rejects (it awaits handlers via allSettled); fire-and-forget from the listener.
180
+ void softShutdown(logger.info.bind(logger), signalHandlers);
181
+ });
182
+ checker.start();
183
+ signalHandlers.push(() => checker.stop());
184
+ }